Api Documentation

Sender Profile

Overview

Each remittance needs a complete sender (KYC) profile on the merchant business. Save it once, then reuse it for later transfers. Create and execute fail until readiness is complete.

Check readiness

HTTP Method	GET
Endpoint URL	`/api/v2/remit/readiness`
Base URL	`https://base-url-here.com`
Description	Return whether the business sender profile is complete.

curl --location --request GET 'https://base-url-here.com/api/v2/remit/readiness' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'X-Business-Id: 9'

{
    "success": true,
    "message": "Success",
    "data": {
        "ready": false,
        "missing": [
            "sender.date_of_birth",
            "sender.doc_number"
        ]
    }
}

Save sender profile

HTTP Method	PUT
Endpoint URL	`/api/v2/remit/sender`
Base URL	`https://base-url-here.com`
Description	Create or replace the sender profile for this business.

Request Body

Field	Type	Description	Required
other_names	string	Sender given names.	Yes
surname	string	Sender family name.	Yes
phone	string	Sender phone in international format.	Yes
nationality	string	ISO country of nationality, e.g. KE.	Yes
doc_type	string	`passport`, `national_id`, or `id`. Stored as PASSPORT or ID.	Yes
doc_number	string	ID or passport number.	Yes
date_of_birth	string	Date of birth, e.g. 1990-01-31.	Yes
origin_country	string	ISO country the funds originate from, e.g. KE.	Yes

curl --location --request PUT 'https://base-url-here.com/api/v2/remit/sender' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'X-Business-Id: 9' \
--data-raw '{
    "other_names": "Jane",
    "surname": "Wanjiku",
    "phone": "254712000000",
    "nationality": "KE",
    "doc_type": "national_id",
    "doc_number": "12345678",
    "date_of_birth": "1990-01-31",
    "origin_country": "KE"
}'

{
    "success": true,
    "message": "Success",
    "data": {
        "ready": true,
        "missing": []
    }
}

Terms of Use & Legal

By using this API, you agree to our Terms of Service and Privacy Policy. Do not share sensitive data or credentials.