APIs
  1. Alfred API
  2. Onboarding

Get onboarding requirements for a country

get
https://api.sandbox.alfredpay.io/v1/kyc/requirements/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
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 Params
string
enum

Which requirement set, business or individual.

Allowed:
Responses

Updated 7 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago

Did this page help you?