Update User

Update an existing user’s profile.

PATCH /b2b/users/{user}

Update User

cURL

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

200

{
  "result": "success"
}

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

Path Parameters

user · string · required

Internet International Bank Account Number (IIBAN)

Required string length: 14 - 42

Body

application/json

tos_version_accepted · integer<int32> | null

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

full_name · object

User's full name

Show child attributes

date_of_birth · string<date> | null

User's date of birth

city_of_birth · string | null

User's city of birth

country_of_birth · enum<string> | null

User's country of birth

Available options: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW, AC, AN, AP, CP, DG, EA, EU, IC, JX, TA, QO, XK, 0C

residence · object

User's residential address

Show child attributes

phone · string | null

Phone number in E.164 format

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

nationalities · enum<string>[] | null

User's nationalities

An ISO 3166-1 alpha-2 country code

Available options: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW, AC, AN, AP, CP, DG, EA, EU, IC, JX, TA, QO, XK, 0C

tax_ids · object[] | null

User's tax ID

Show child attributes

occupation · enum<string> | null

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

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

200

application/json

Response

result · enum<string> | null

Available options: success