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

Body

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.uat.sokin.com/beneficiaries?corporateReference' \
--header 'x-api-version;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "displayName": "Faye McKenzie",
    "entityType": "company",
    "countryCode": "SN",
    "currencyCode": "SEK",
    "paymentRail": "sepa",
    "bankAccount": null,
    "eTransfer": null,
    "virtualAccount": {
        "providerCode": "43",
        "accountNumber": "57935666",
        "accountName": null
    },
    "sokinInternal": null,
    "individual": {
        "firstName": null,
        "middleName": null,
        "lastName": null,
        "secondLastName": null,
        "dateOfBirth": "commodo id adipisicing eiusmod",
        "nationality": null,
        "countryOfBirth": null,
        "fatherName": "tempor nisi in",
        "motherName": "cupidatat ad Lorem laborum",
        "gender": "anim non",
        "idType": "eiusmod sed con",
        "idNumber": null
    },
    "company": null,
    "address": {
        "line1": "ipsum pariatur sed dolore",
        "line2": "magna Excepteur laboru",
        "line3": null,
        "city": "North Moniqueland",
        "stateOrProvince": null,
        "postalCode": "30470-2340",
        "countryCode": "KI"
    },
    "providerMetadata": {
        "Ut9_e": "mollit quis reprehenderit dolor commodo",
        "cupidatat_8": "adipisicing culpa laboris ut",
        "doloreb6": "deserunt adipisicing"
    }
}'

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",
                "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-14 15:42:40

Get Beneficiary Schema

Get Beneficiary List