Create Beneficiary

Testing Env

https://api.uat.sokin.com

POST

/beneficiaries

Request new beneficiary for the current corporate.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Successful Response

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.uat.sokin.com/beneficiaries?corporateReference=undefined' \
--header 'x-api-version;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "displayName": "string",
    "entityType": "individual",
    "countryCode": "st",
    "currencyCode": "AED",
    "paymentRail": "internal",
    "bankAccount": {
        "accountNumber": "string",
        "accountNumberType": "iban",
        "accountCategory": "checking",
        "accountHolderName": "string",
        "institution": {
            "countryCode": "st",
            "name": "string",
            "routingCodeScheme": "bic_swift",
            "routingCodeValue": "string",
            "branchName": "string",
            "branchCode": "string",
            "branchCity": "string",
            "externalId": "string"
        }
    },
    "eTransfer": {
        "email": "string",
        "securityQuestion": "string",
        "securityAnswer": "string"
    },
    "virtualAccount": {
        "providerCode": "string",
        "accountNumber": "string",
        "accountName": "string"
    },
    "sokinInternal": {
        "targetCorporateCode": "string"
    },
    "individual": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "secondLastName": "string",
        "dateOfBirth": "string",
        "nationality": "st",
        "countryOfBirth": "st",
        "fatherName": "string",
        "motherName": "string",
        "gender": "string",
        "idType": "string",
        "idNumber": "string"
    },
    "company": {
        "legalName": "string",
        "tradingName": "string",
        "registrationNumber": "string",
        "taxId": "string",
        "dateOfIncorporation": "string",
        "countryOfIncorporation": "st",
        "industryCategory": "string",
        "industrySubcategory": "string"
    },
    "address": {
        "line1": "string",
        "line2": "string",
        "line3": "string",
        "city": "string",
        "stateOrProvince": "string",
        "postalCode": "string",
        "countryCode": "st"
    },
    "providerMetadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

201 - Example 1

{
    "message": "string",
    "data": {
        "externalReference": "string",
        "displayName": "string",
        "entityType": "individual",
        "countryCode": "string",
        "status": "active",
        "isInternal": true,
        "supportedRails": [
            "internal"
        ],
        "destinations": [
            {
                "currencyCode": "string",
                "paymentRail": "string",
                "validationStatus": "not_validated",
                "property1": "string",
                "property2": "string"
            }
        ],
        "individual": {
            "firstName": "string",
            "middleName": "string",
            "lastName": "string",
            "secondLastName": "string",
            "dateOfBirth": "string",
            "nationality": "string",
            "countryOfBirth": "string",
            "gender": "string"
        },
        "company": {
            "legalName": "string",
            "tradingName": "string",
            "registrationNumber": "string",
            "dateOfIncorporation": "string",
            "countryOfIncorporation": "string",
            "industryCategory": "string",
            "industrySubcategory": "string"
        },
        "address": {
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "city": "string",
            "stateOrProvince": "string",
            "postalCode": "string",
            "countryCode": "string"
        },
        "createdAt": "2019-08-24T14:15:22.123Z",
        "version": 0
    }
}

Modified at 2026-04-16 20:09:33

Get Beneficiary Schema

Get Beneficiary List