Skip to main content
GET
Customer KYC package requirements
Return the full KYC package for a customer type before create/submit.

Query

  • type — individual (default) or business
  • country — optional ISO code; sharpens corridor-specific conditional fields (e.g. NG BVN, US EIN)
Response data lists required_fields, required_documents, optional_fields, and conditional_fields. For business, nested officer fields are under field_shapes.officers (not top-level required_fields). Use this to build profile on POST /partner/customers and document uploads.
This is not the same as GET /partner/order-requirements (quote field hints per corridor).

Authorizations

X-API-Key
string
header
required

Partner API key. Sandbox keys start with is_test_; production keys start with is_live_. Keys are not interchangeable across environments. Send on every request. Never expose in browser or mobile clients.

Query Parameters

type
enum<string>
default:individual

individual or business

Available options:
individual,
business
country
string | null

Optional ISO country (e.g. US) for corridor-conditioned fields like tax_id

Response

Required profile fields and document categories for the requested customer type.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"Customer requirements"

data
PartnerCustomerRequirementsData · object
required