---
title: "Get onboarding requirements for a country"
method: GET
path: "/v1/kyc/requirements/{country}"
tags: ["Onboarding"]
---

# Get onboarding requirements for a country

`GET /v1/kyc/requirements/{country}`

## Request

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

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`.

## 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'

## Response `200`

OK

- RequirementSet
  - `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'
  - `version` string: Version of the requirement set, so a cached form can be checked for changes.
  - `fields` object[]
    - `name` string
    - `required` boolean
    - `description` string
  - `documents` object[]
    - `purpose` string
    - `required` boolean
    - `description` string

## Other responses

- `404`: The resource does not exist, or belongs to another partner.

## Changes

- **2026-11-03** `20fef4fd2ab3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation/changes/v1/kyc/requirements/:country/get.md)

---

[API](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation.md) - [All operations](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/alfredpay/apis/alfred-penny-api-client-documentation/revisions/20fef4fd2ab3?raw)