Internal API

Consumer auth

5 endpoints.

POST/api/v1/internal/consumer-auth/complete

Complete

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonCompleteBody

Field	Type	Description
`business_id`required	`string (uuid)`
`phone`required	`string`
`email`required	`string`
`first_name`required	`string`
`last_name`required	`string`
`webchat_session_id`	`string \| null`
`client_user_agent`	`string \| null`
`client_ip`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_CompleteData_

Field Type Description

request_idrequired string

success true default true

datarequired

CompleteData

CompleteData fields

Field Type Description

consumer_idrequired string (uuid)

consumerrequired

ConsumerAuthProfile

ConsumerAuthProfile fields

Field	Type	Description
`id`required	`string (uuid)`
`email`	`string \| null`
`phone`	`string \| null`
`primary_identifier`	`string \| null`
`first_name`	`string \| null`
`last_name`	`string \| null`

event_id string | null

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/consumer-auth/phone-entry

Phone Entry

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonPhoneEntryBody

Field	Type	Description
`business_id`required	`string (uuid)`
`phone`required	`string`

Responses

200Successful Response

application/jsonSuccessResponse_PhoneEntryData_

Field Type Description

request_idrequired string

success true default true

datarequired

PhoneEntryData

PhoneEntryData fields

Field	Type	Description
`consumer_id`required	`string (uuid)`
`business_contact_id`required	`string (uuid)`
`contact_was_new`	`boolean`	default false

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/internal/consumer-auth/prefill

Prefill

Parameters

Name	In	Type
`business_id`required	query	`string (uuid)`
`phone`required	query	`string`
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PrefillData_

Field Type Description

request_idrequired string

success true default true

datarequired

PrefillData

PrefillData fields

Field	Type	Description
`first_name`	`string \| null`
`last_name`	`string \| null`
`email`	`string \| null`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/consumer-auth/resolve-api-key

Resolve Api Key

Parameters

Name	In	Type	Description
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonResolveApiKeyBody

Field	Type	Description
`api_key`required	`string`

Responses

200Successful Response

application/jsonSuccessResponse_ResolveApiKeyData_

Field Type Description

request_idrequired string

success true default true

datarequired

ResolveApiKeyData

ResolveApiKeyData fields

Field	Type	Description
`business_id`required	`string (uuid)`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/internal/consumers/{consumer_id}/portal-profile

Consumer Portal Profile

Parameters

Name	In	Type
`consumer_id`required	path	`string (uuid)`
`business_id`	query	`string (uuid) \| null`
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonany

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.