Auth service

Internal

9 endpoints.

POST/api/v1/internal/account-invites/send-email

Send Account Invite Email

Parameters

Name	In	Type	Description
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalAccountInviteEmailRequest

Field	Type	Description
`email`required	`string (email)`
`business_name`required	`string`
`invite_id`required	`string`
`owner_name`	`string`	default ""

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/internal/billing-notifications/send-email

Send Billing Notification Email

Email one business user about a billing event (DF-10). Called per recipient by sor, which owns the business↔user mapping; this service only knows how to render and send.

**422 on a kind we have no copy for.** The alternative — generic wording — produces an email that names no amount, no date and no reason, which spends the customer's one notification on nothing and reports nothing to us. The caller retries and dead-letters it, so it surfaces as a tracked failure. `notification_data` gets no such treatment: it is best-effort, and a missing or unreadable value costs a line in the callout rather than the email.

Parameters

Name	In	Type	Description
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalBillingNotificationEmailRequest

Field	Type	Description
`email`required	`string (email)`
`business_name`required	`string`
`kind`required	`string`	max length 64
`billing_url`	`string (uri) \| null`
`notification_data`	`object`
`event_id`	`string`	default ""

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/internal/escalation-notifications/send-email

Send Escalation Notification Email

Parameters

Name	In	Type	Description
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalEscalationNotificationEmailRequest

Field	Type	Description
`email`required	`string (email)`
`business_name`required	`string`
`escalation_reason`	`string`	default ""
`consumer_label`	`string`	default ""
`matched_keyword`	`string`	default ""
`last_message_preview`	`string`	default ""
`conversation_url`	`string (uri) \| null`

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/internal/lead-notifications/send-email

Send Lead Notification Email

Parameters

Name	In	Type	Description
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalLeadNotificationEmailRequest

Field Type Description

emailrequired string (email)

business_namerequired string

lead_name string default ""

lead_email string default ""

lead_phone string default ""

lead_message string default ""

contact_url string (uri) | null

kind string default "new_lead"

source string default "website_form"

lead_fields

LeadFieldItem[]

default []

LeadFieldItem[] fields

Field	Type	Description
`label`required	`string`
`value`required	`string`

partial_details boolean default false

ai_pursuing boolean default false

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/internal/review-notifications/send-email

Send Review Notification Email

Parameters

Name	In	Type	Description
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalReviewNotificationEmailRequest

Field	Type	Description
`email`required	`string (email)`
`business_name`required	`string`
`listing_title`	`string`	default ""
`reviewer_name`	`string`	default ""
`rating`	`integer \| null`
`review_body`	`string`	default ""
`review_url`	`string (uri) \| null`

Responses

200Successful Response

application/jsonany

422Validation Error

Error bodies: HTTPValidationError. See Errors.

GET/api/v1/internal/users

List Users

Parameters

Name	In	Type	Description
`role_id`required	query	`integer`	Filter by Heimdal role_id
`limit`	query	`integer`	default 100
`offset`	query	`integer`	default 0
`X-Internal-Api-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonInternalUserListResponse

Field Type Description

usersrequired

InternalUserRecord[]

InternalUserRecord[] fields

Field	Type	Description
`user_id`required	`string (uuid)`
`email`required	`string (email)`
`first_name`	`string \| null`
`last_name`	`string \| null`
`phone`	`string \| null`
`role_id`required	`integer`
`is_active`required	`boolean`
`email_verified`required	`boolean`
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

422Validation Error

Error bodies: HTTPValidationError. See Errors.

PATCH/api/v1/internal/users/{user_id}

Update User

Parameters

Name	In	Type	Description
`user_id`required	path	`string (uuid)`
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalUserUpdateRequest

Field	Type	Description
`first_name`	`string \| null`
`last_name`	`string \| null`
`phone`	`string \| null`
`email`	`string (email) \| null`
`role_id`	`integer \| null`
`is_active`	`boolean \| null`

Responses

200Successful Response

application/jsonInternalUserRecord

InternalUserRecord, expanded above.

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/internal/users/lookup

Lookup Users

Parameters

Name	In	Type	Description
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalUserLookupRequest

Field	Type	Description
`user_ids`	`string (uuid)[]`	default [] string (uuid)[] fields
`emails`	`string (email)[]`	default [] string (email)[] fields

Responses

200Successful Response

application/jsonInternalUserLookupResponse

Field	Type	Description
`users`required	`InternalUserRecord[]`	InternalUserRecord[] fields InternalUserRecord, expanded above.

422Validation Error

Error bodies: HTTPValidationError. See Errors.

POST/api/v1/internal/users/provision

Provision User

Parameters

Name	In	Type	Description
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonInternalProvisionUserRequest

Field	Type	Description
`email`required	`string (email)`
`first_name`required	`string`
`last_name`required	`string`
`phone`	`string \| null`
`role_id`	`integer`	default 400
`send_password_reset`	`boolean`	default true

Responses

200User updated successfully

application/jsonInternalProvisionUserResponse

Field	Type	Description
`user_id`required	`string (uuid)`
`email`required	`string (email)`
`first_name`	`string \| null`
`last_name`	`string \| null`
`phone`	`string \| null`
`role_id`required	`integer`
`created`required	`boolean`
`password_reset_sent`required	`boolean`

201Successful Response

application/jsonInternalProvisionUserResponse

InternalProvisionUserResponse, expanded above.

422Validation Error

Error bodies: HTTPValidationError. See Errors.