Read a customer's onboarding state
GET/subjects/:externalUserRef
Machine token. Called by your backend, using your client_credentials token.
Current onboarding state and the verification status of each contact channel, addressed by your own user id. Use it to drive your UI, and as the catch-up path when a webhook was missed.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
OK
Malformed request — validation failure, or a header such as Idempotency-Key is missing or not a UUID.
Missing, expired, or untrusted bearer token.
Authenticated but not permitted — the caller's role or scope does not grant this operation, or the resource belongs to another tenant.
The referenced wallet, transaction, user, or tenant does not exist within the caller's tenant.
Unexpected server error.