ALalfredpay
Onboarding

Get onboarding requirements for a country

Changed on

Returns what a customer in this country has to provide. Read it before you collect anything from them.

Pass ?type=INDIVIDUAL for the per-person requirements. There's no separate individual-requirements endpoint; this is it.

The path parameter is alpha-3, so MEX. If you send alpha-2 it's normalized at the boundary and the response still comes back as MEX.

get/v1/kyc/requirements/{country}

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/kyc/requirements/{country}
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Path parameters

country'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY' required

ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound country value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → 422 validation_error.

Query parameters

type'INDIVIDUAL' | 'BUSINESS'

Which requirement set, business or individual.

Response

OK

country'MEX' | 'ARG' | 'BRA' | 'COL' | 'CHL' | 'PER' | 'DOM' | 'USA' | 'CHN' | 'HKG' | 'BOL' | 'PRY'

ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for integrations that can only send alpha-2: any inbound country value in alpha-2 (path, query or body) is normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form → 422 validation_error.

type'INDIVIDUAL' | 'BUSINESS'
versionstring

Version of the requirement set, so a cached form can be checked for changes.

Changes