Skip to main content
Customers represent the people or businesses that send or receive money through your integration. Create customers before payment flows so each quote, payin, payout, transfer, and webhook can be reconciled back to your internal records. Use external_ref to store your own customer identifier.

Customer types

TypeUse caseRequired identity fields
individualA person sending or receiving money.first_name, last_name
retailA person identified mainly by document number.first_name, last_name, id_number
businessA business customer.business_name
Provider requirements vary by country, operator, and corridor. For payout and transfer flows, collect the fullest profile you can:
  • Name or business name
  • Phone number in E.164 format
  • Email address
  • Country and nationality codes
  • Date of birth
  • Address and city
  • Occupation and source of funds
For Yellow Card-backed payouts, make sure the customer profile includes address_line1, city, occupation, and source_of_funds.

KYC documents

Submit KYC documents through POST /customers/{customer_id}/kyc. Document files must be hosted at public HTTPS URLs that Bumxpress can fetch. Supported document examples include national_id and passport. At least one file URL is required per document, such as front_file_url, back_file_url, or selfie_file_url.

Status tracking

Read KYC state with GET /customers/{customer_id}/kyc. Store the returned kyc_status and document IDs in your system so support and compliance teams can reconcile provider requirements.
Last modified on July 8, 2026