ALalfredpay
Onboarding

Check hosted onboarding progress

Changed on

Returns where the end customer has got to. Minting a link starts a session and this call reads it.

Poll it, or subscribe to customer.verification.updated instead. A customer has one session at a time, and minting a new link supersedes the previous one.

get/v1/customers/{customerId}/onboarding-session

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/customers/{customerId}/onboarding-session
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Response

OK

sessionIdstring
customerIdstring
status'CREATED' | 'OPENED' | 'IN_PROGRESS' | 'SUBMITTED' | 'COMPLETED' | 'EXPIRED' | 'ABANDONED'
verificationIdstring nullable

Set once the session has been submitted and a verification exists.

linkExpiresAtstring date-time
lastActivityAtstring date-time nullable

Changes