Onboarding

Submit for verification

Changed on

The commit, for KYC and KYB alike. There's no body: the customer has exactly one draft, and this freezes it, creates a verification and starts the review. The customer's type decides which path runs.

After this, material changes go through /reevaluate. Never submit a second verification.

Wait on customer.verification.updated. See Webhooks and events.

post/v1/customers/{customerId}/verifications

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/customers/{customerId}/verifications
  • 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

Submitted

idstring
submissionIdstring
type'INDIVIDUAL' | 'BUSINESS'
status'SUBMITTED' | 'IN_REVIEW' | 'APPROVED' | 'REJECTED' | 'RFI'
createdAtstring date-time
updatedAtstring date-time

Changes