Create User

Create a new user in the Payward system.

POST /b2b/users

Create User

cURL

curl --request POST \
  --url https://nexus.kraken.com/b2b/users \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "external_id": "<string>",
  "tos_version_accepted": 123,
  "full_name": {
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>"
  },
  "date_of_birth": "2023-12-25",
  "residence": {
    "line1": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "country": "<unknown>",
    "line2": "<string>",
    "province": "<string>"
  },
  "phone": "<string>",
  "nationalities": [
    "<unknown>"
  ],
  "occupation": "agriculture",
  "employer_name": "<string>",
  "client_identifier": {
    "type": "concat",
    "value": "<string>",
    "calculated_at": "2023-11-07T05:31:56Z"
  },
  "city_of_birth": "<string>",
  "country_of_birth": "<unknown>",
  "tax_ids": [
    {
      "id": "<string>",
      "issuing_country": "<unknown>"
    }
  ],
  "language": "<string>"
}
'

201

{
  "result": {
    "user": "<string>"
  }
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Headers

Payward-Version · enum<string> · default: 2025-04-15

The target version of the Embed API to use. The API version name is based on the date when the API version was released. For example, the API version 2025-04-15 was released on April 15, 2025.

Available options: 2025-04-15

Body

application/json

email · string<email> · required

The email associated with the account.

external_id · string · required

An external user ID for partners to link their user ID to a Payward account.

tos_version_accepted · integer<int32> · required

Versions of Payward's Terms of Service accepted by the user

full_name · object · required

User's full name

Show child attributes

date_of_birth · string<date> · required

User's date of birth

residence · object · required

User's residential address

Show child attributes

phone · string · required

Phone number in E.164 format

Pattern: ^\+?[1-9]\d{1,14}$

nationalities · any[] · required

User's nationalities

occupation · enum<string> · required

User's occupation

Available options: agriculture, business_management, computers_and_it, construction, education, finance, government, healthcare, hospitality, manufacturing, marketing, media, other, science, self_employed, student, transportation, unemployed, employed

employer_name · string | null

Name of user's employer

client_identifier · object

Identifier assigned by the partner platform

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes

city_of_birth · string | null

User's city of birth

country_of_birth · any

User's country of birth

tax_ids · object[] | null

User's tax ID

Show child attributes

language · string | null

The user's preferred language, as an ISO 639-1 language code. If not provided, the user's language will be set to the default language for their country.

Response

201

application/json

Response

result · object

Show child attributes