Get Beneficiary Schema

Testing Env

https://api.uat.sokin.com

GET

/beneficiaries/schema

Get beneficiary creation schema (required fields and optional regional hints) for the given context.

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

Responses

🟢200

application/json

Successful Response

Body

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.uat.sokin.com/beneficiaries/schema?currencyCode&entityType&paymentMethod&countryCode&corporateReference' \
--header 'x-api-version;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "message": "string",
    "data": {
        "condition": {
            "currencyCode": "string",
            "entityType": "string",
            "countryCode": "string",
            "paymentMethod": "string"
        },
        "fields": [
            {
                "name": "string",
                "fieldType": "string",
                "min": 0,
                "max": 0,
                "isRequired": true,
                "allowedValues": [
                    "string"
                ]
            }
        ],
        "regional": {
            "states": [
                {
                    "code": "string",
                    "name": "string"
                }
            ]
        }
    }
}

Modified at 2026-04-14 15:42:50

PaginatedApiResponse_GetCCAsResponseItem_

Create Beneficiary