Skip to main content
GET
Get a customer
A customer’s current status, read live. Use it if you missed a webhook or want to check before showing someone a screen. Another business’s customer reads as 404.

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string
required

Response

customerId
string
required
Example:

"cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790"

externalUserId
string
required
Example:

"acme-user-123"

status
enum<string>
required

Read live, so it reflects any decision made since.

Available options:
OTP_SENT,
VERIFIED,
IN_REVIEW,
DECLINED
Example:

"VERIFIED"

tier
number
Example:

1

declineCode
enum<string>
Available options:
ID_NOT_VERIFIED,
ATTEMPTS_EXCEEDED,
ALREADY_LINKED