Submit enterprise KYB

Full KYB payload for a Sender registered as enterprise. Every file_id referenced must come from Upload a Sender file on this same Sender. Starts asynchronous partner review — status doesn’t flip to ready on this call.

POST /api/v2/payouts/senders/{id}/kyc/enterprise

Submit enterprise KYB

cURL

curl --request POST \
  --url https://api.mansa.xyz/api/v2/payouts/senders/{id}/kyc/enterprise \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "member_name": "<string>",
  "name_on_cert": "<string>",
  "reg_country": "<string>",
  "province": "<string>",
  "city": "<string>",
  "reg_address": "<string>",
  "postcode": "<string>",
  "actual_operating_address": "<string>",
  "reg_number": "<string>",
  "phone_area_code": "<string>",
  "phone_num": "<string>",
  "email": "<string>",
  "effective_date": "<string>",
  "industry_type": "<string>",
  "business_scope": "<string>",
  "business_category": "<string>",
  "operation_region": "<string>",
  "payment_regions": "<string>",
  "export_regions": "<string>",
  "business_use_case": "<string>",
  "kyc_files": [
    {
      "file_type": "<string>",
      "file_id": "<string>"
    }
  ],
  "stakeholder_info": [
    {
      "name": "<string>",
      "nationality": "<string>",
      "document_issuing_country": "<string>",
      "cert_type": "<string>",
      "cert_num": "<string>",
      "effective_date": "<string>",
      "cert_front": "<string>",
      "birthday": "<string>",
      "residence_area": "<string>",
      "province": "<string>",
      "city": "<string>",
      "address": "<string>",
      "expiration_date": "<string>",
      "is_long_term": "0",
      "cert_back": "<string>",
      "share_percentage": "16.36"
    }
  ]
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "profile_type": "enterprise",
  "legal_name": "<string>",
  "country_code": "<string>",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "registration_number": "<string>",
  "address": "<string>",
  "contact_email": "<string>",
  "contact_phone": "<string>",
  "status_reason": "<string>"
}

Authorizations

x-api-key · string · header · required

API key for authentication

Authorization · string · header · required

ES256 JWT signed by the private key registered to the API key above. Claims: sub (=API key), uri, nbf, iat, exp, and bodyHash (HMAC-SHA512 of uri + rawBody + nbf using a shared secret, base64).

Path Parameters

id · string<uuid> · required

ID of the Sender

Body

application/json

Full KYB payload for a Sender registered as enterprise.

member_name · string · required

Company name (English)

name_on_cert · string · required

Exactly as on the registration certificate

reg_country · string · required

ISO 3166-1 alpha-2

province · string · required

city · string · required

reg_address · string · required

Including house/unit number

postcode · string · required

actual_operating_address · string · required

reg_number · string · required

Business registration number

phone_area_code · string · required

No '+', e.g. "852"

phone_num · string · required

email · string · required

effective_date · string · required

yyyy-MM-dd — registration date

business_type · enum<string> · required

1 Limited Co · 2 LLC · 3 Sole prop · 4 Listed · 5 Unlisted stock · 6 State-owned · 7 Other

Available options: 1, 2, 3, 4, 5, 6, 7

industry_type · string · required

Partner's fixed code, e.g. "T1030001"

business_scope · string · required

business_category · string · required

operation_region · string · required

ISO 3166-1 alpha-2, comma-separated

payment_regions · string · required

Main source of incoming funds

export_regions · string · required

Where outgoing funds mainly go

amt_count · enum<string> · required

Monthly tx count: 1 >1000 · 2 100–1000 · 3 1–99

Available options: 1, 2, 3

amt_amt · enum<string> · required

Monthly volume (USD): 1 >4M · 2 300k–999,999 · 3 >1M

Available options: 1, 2, 3

ex_amt · enum<string> · required

Single-tx amount (USD): 1 >100k · 2 10k–99,999 · 3 0–1M

Available options: 1, 2, 3

business_use_case · string · required

kyc_files · object[] · required

Minimum array length: 1

Show child attributes

stakeholder_info · object[] · required

Beneficial owners/directors/signatories.

Minimum array length: 1

Show child attributes

expiration_date · string

Required unless is_long_term is "1".

is_long_term · enum<string> · default: 0

Available options: 0, 1

business_type_other · string

Required when business_type is "7".

industry_type_other · string

Required when industry_type is "T1030099".

domestic_entity_name · string

website · string

Response

200

application/json

KYB submitted — review is asynchronous, status does not flip here.

id · string<uuid> · required

profile_type · enum<string> · required

Available options: enterprise, individual

legal_name · string · required

country_code · string · required

status · enum<string> · required

Starts pending. No client action moves it — resolves automatically once asynchronous partner KYC/KYB review completes.

Available options: pending, ready, rejected

created_at · string<date-time> · required

updated_at · string<date-time> · required

registration_number · string | null

address · string | null

contact_email · string | null

contact_phone · string | null

status_reason · string | null

Present only when status is rejected.