ALalfredpay
Onboarding

Create a hosted onboarding link

Changed on

Mints a scoped link the end customer opens themselves. They complete identity capture, documents and the selfie directly with Alfred, so you never handle document images.

Worth defaulting to for individual KYC, where the alternative is building document capture and liveness for every country template yourself.

post/v1/customers/{customerId}/onboarding-link

Request

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

Headers

Idempotency-Keystring uuid required

Required on every state-changing POST, simulators included; the only exempt POST is …/verifications/preflight. Replay (same key, same body) returns the original response with Idempotent-Replayed: true; same key with a different body → 409 idempotency_conflict. Keys are UUIDs, scoped to the API key, retained for 24 hours.

Response

Created

sessionIdstring
urlstring uri
expiresAtstring date-time

Changes