Skip to main content
POST
Import customer identity

Authorizations

Authorization
string
header
required

Your secret API key, passed as Authorization: Api-Key <secret key>, for example Authorization: Api-Key sk_test_key. Secret keys are prefixed with sk_test_ (sandbox) or sk_live_ (production) and must only be used server-side. Never expose them in client code. Find your keys on the API keys page of the dashboard. See Authentication.

Body

application/json
externalCustomerId
string
required

A unique identifier for the customer on your platform. Pass the same value to the widget as the externalCustomerId parameter.

Example:

"123"

identity
object[]
required

The identity records to import for this customer.

Response

200

Successful response: the identity was accepted for import. The body is empty.