Mansa Docs

Submit personal KYC

curl --request POST \
  --url https://api.mansa.xyz/api/v2/payouts/senders/{id}/kyc/personal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "member_name": "<string>",
  "name_on_cert": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "birthday": "<string>",
  "cert_num": "<string>",
  "effective_date": "<string>",
  "cert_area": "<string>",
  "residence_area": "<string>",
  "province": "<string>",
  "city": "<string>",
  "address": "<string>",
  "postcode": "<string>",
  "phone_area_code": "<string>",
  "phone_num": "<string>",
  "email": "<string>",
  "payment_regions": "<string>",
  "export_regions": "<string>",
  "occupation_type": "<string>",
  "employer_info": "<string>",
  "kyc_files": [
    {
      "file_type": "<string>",
      "file_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.mansa.xyz/api/v2/payouts/senders/{id}/kyc/personal"

payload = {
    "member_name": "<string>",
    "name_on_cert": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "birthday": "<string>",
    "cert_num": "<string>",
    "effective_date": "<string>",
    "cert_area": "<string>",
    "residence_area": "<string>",
    "province": "<string>",
    "city": "<string>",
    "address": "<string>",
    "postcode": "<string>",
    "phone_area_code": "<string>",
    "phone_num": "<string>",
    "email": "<string>",
    "payment_regions": "<string>",
    "export_regions": "<string>",
    "occupation_type": "<string>",
    "employer_info": "<string>",
    "kyc_files": [
        {
            "file_type": "<string>",
            "file_id": "<string>"
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    member_name: '<string>',
    name_on_cert: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    birthday: '<string>',
    cert_num: '<string>',
    effective_date: '<string>',
    cert_area: '<string>',
    residence_area: '<string>',
    province: '<string>',
    city: '<string>',
    address: '<string>',
    postcode: '<string>',
    phone_area_code: '<string>',
    phone_num: '<string>',
    email: '<string>',
    payment_regions: '<string>',
    export_regions: '<string>',
    occupation_type: '<string>',
    employer_info: '<string>',
    kyc_files: [{file_type: '<string>', file_id: '<string>'}]
  })
};

fetch('https://api.mansa.xyz/api/v2/payouts/senders/{id}/kyc/personal', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

{
  "statusCode": 400,
  "message": "sender is not ready"
}

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Sender not found"
}

{
  "statusCode": 422,
  "message": [
    "legal_name should not be empty",
    "country_code must be a valid ISO 3166-1 alpha-2 code"
  ]
}

{
  "statusCode": 429,
  "message": "Too many requests"
}

{
  "statusCode": 500,
  "message": "Internal server error"
}

POST

api

payouts

senders

{id}

kyc

personal

Submit personal KYC

curl --request POST \
  --url https://api.mansa.xyz/api/v2/payouts/senders/{id}/kyc/personal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "member_name": "<string>",
  "name_on_cert": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "birthday": "<string>",
  "cert_num": "<string>",
  "effective_date": "<string>",
  "cert_area": "<string>",
  "residence_area": "<string>",
  "province": "<string>",
  "city": "<string>",
  "address": "<string>",
  "postcode": "<string>",
  "phone_area_code": "<string>",
  "phone_num": "<string>",
  "email": "<string>",
  "payment_regions": "<string>",
  "export_regions": "<string>",
  "occupation_type": "<string>",
  "employer_info": "<string>",
  "kyc_files": [
    {
      "file_type": "<string>",
      "file_id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.mansa.xyz/api/v2/payouts/senders/{id}/kyc/personal"

payload = {
    "member_name": "<string>",
    "name_on_cert": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "birthday": "<string>",
    "cert_num": "<string>",
    "effective_date": "<string>",
    "cert_area": "<string>",
    "residence_area": "<string>",
    "province": "<string>",
    "city": "<string>",
    "address": "<string>",
    "postcode": "<string>",
    "phone_area_code": "<string>",
    "phone_num": "<string>",
    "email": "<string>",
    "payment_regions": "<string>",
    "export_regions": "<string>",
    "occupation_type": "<string>",
    "employer_info": "<string>",
    "kyc_files": [
        {
            "file_type": "<string>",
            "file_id": "<string>"
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    member_name: '<string>',
    name_on_cert: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    birthday: '<string>',
    cert_num: '<string>',
    effective_date: '<string>',
    cert_area: '<string>',
    residence_area: '<string>',
    province: '<string>',
    city: '<string>',
    address: '<string>',
    postcode: '<string>',
    phone_area_code: '<string>',
    phone_num: '<string>',
    email: '<string>',
    payment_regions: '<string>',
    export_regions: '<string>',
    occupation_type: '<string>',
    employer_info: '<string>',
    kyc_files: [{file_type: '<string>', file_id: '<string>'}]
  })
};

fetch('https://api.mansa.xyz/api/v2/payouts/senders/{id}/kyc/personal', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

{
  "statusCode": 400,
  "message": "sender is not ready"
}

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Sender not found"
}

{
  "statusCode": 422,
  "message": [
    "legal_name should not be empty",
    "country_code must be a valid ISO 3166-1 alpha-2 code"
  ]
}

{
  "statusCode": 429,
  "message": "Too many requests"
}

{
  "statusCode": 500,
  "message": "Internal server error"
}

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

string<uuid>

required

ID of the Sender

Body

application/json

Full KYC payload for a Sender registered as individual.

member_name

string

required

Full name (English)

name_on_cert

string

required

As on the identity document

first_name

string

required

last_name

string

required

gender

enum<string>

required

1 male, 2 female

Available options:

1,

2

birthday

string

required

yyyy-MM-dd

cert_type

enum<string>

required

ID card · Passport · Driver's license

Available options:

11,

13,

14

cert_num

string

required

effective_date

string

required

yyyy-MM-dd

cert_area

string

required

ISO 3166-1 alpha-2, document's issuing country

residence_area

string

required

ISO 3166-1 alpha-2, country of residence

province

string

required

city

string

required

address

string

required

Including house/unit number

postcode

string

required

phone_area_code

string

required

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

phone_num

string

required

string

required

payment_regions

string

required

ISO 3166-1 alpha-2, comma-separated

export_regions

string

required

ISO 3166-1 alpha-2, comma-separated

funds_source

enum<string>

required

1 Salary · 2 Savings · 3 Investment return · 4 Other

Available options:

1,

2,

3,

4

emt_amt

enum<string>

required

Monthly volume (USD): 1 0–49,999 · 2 50k–299,999 · 3 >300k

Available options:

1,

2,

3

occupation_type

string

required

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

account_opening_purpose

enum<string>

required

1 Remittance, 2 Currency exchange

Available options:

1,

2

employer_info

string

required

annual_salary_range

enum<string>

required

1 $10k–$100k · 2 $100k–$200k · 3 $200k+

Available options:

1,

2,

3

kyc_files

object[]

required

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

occupation_type_other

string

Required when occupation_type is "T1040099".

Response

KYC submitted

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.

Organizations

Senders

Beneficiaries

Funding

Orders & Batches

Submit personal KYC

Authorizations

Path Parameters

Body

Response