/v2/users

Updated on Jan 13, 2026
Published on Oct 1, 2025

3 minute(s) read

Prev Next

Post

/v2/users

Body parameters

HMAC Operation - user_create

Expand All

object

string Required

Email address of the user

Examplejohn.doe@example.com

firstName

string | null

First name of the user

ExampleJohn

lastName

string | null

Last name of the user

ExampleDoe

address1

string | null

Address of the user

ExampleJames Bouchier 76a

address2

string | null

country

string | null

Country of resident of the user (Alpha-2)

ExampleBG

city

string | null

City of the user

ExampleSofia

zip

string | null

ZIP/Postal Code of the user

Example1407

phone

string | null

Phone of the user

Example+3590000000

mobilePhone

string | null

Mobile Phone of the user

Example+3590000000

language

string | null

nationality

string | null

Nationality of the user (Alpha-2)

ExampleBG

birthday

string (date-time) | null

Date of birth of the user (YYYY-MM-DD)

Example1980-01-01T00:00:00Z

aml

string | null

placeOfBirth

string | null

merchant

string

Master Merchant token

Min length32

Max length36

Examplefaf5ee1a-298e-45c7-beb6-b8e410493da3

occupation

string | null

otherOccupation

string | null

Other occupation (free text field)

Max length255

ExampleCustom occupation

education

string | null

info

string | null

moneyDeclaration

string | null

sourceOfFunds

string | null

otherSourceOfFunds

string | null

Other source of funds (free text field)

Max length255

ExampleCustom source of funds

externalReference

string | null

registrationIp

string | null

isSan

string | null

isSip

string | null

pepsDeclaration

string | null

pep

string | null

pepRelative

string | null

uniqueIdentifier

string | null

idPassportValidity

string | null

idPassportNumber

string | null

type

string | null

Valid values[ "card-usage", "default" ]

documents

Array of object (DocumentDto2) | null

object

file

string | null

Base64 encoded file

ExampleiVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3/HwADvgI9/iYBsgAAAABJRU5ErkJggg==

fileType

string | null

Type of the file

Valid values[ "pdf", "docx", "xlxs", "jpg", "jpeg", "png", "mov", "mp4" ]

Examplepdf

documentType

string | null

More details in nomenclatures section

Valid values[ "idcard", "bankstmt", "bill", "other", "idcard-front", "idcard-back", "idcard-selfie", "passport-back", "passport-selfie", "passport", "driving-license-selfie", "selfie", "driving-license-front", "driving-license-back", "sharebook-excerpt", "management-contract", "moms-of-the-board", "activity-license", "bank-account", "bulstat-registration", "vat-registration", "patent-law", "power-of-attorney", "ubo-declaration", "frame-contract", "sample-of-signatures", "face-compare", "proof", "recent-excerpt", "incorporation-documents", "share_holders_list", "other_corporate", "signature", "id_card_passport_photo", "biometric-residence-permit-front", "biometric-residence-permit-back", "kyc-vendor-report", "fatca-declaration", "sow-declaration", "sof-desclaration", "resident-permit-eu-uk-front", "resident-permit-eu-uk-back" ]

Examplepassport

middleName

string | null

Middle name of the user

Max length255

ExampleJames

proofOfIdentityType

string | null

Type of identity document

Valid values[ "ID", "Passport", "Driving license – UK only", "Other" ]

Max length100

ExamplePassport

idIssueDate

string (date-time) | null

Date when ID was issued

Example2020-01-01T00:00:00Z

countryIssuingIdCard

string | null

Country that issued the ID card (ISO 3166-1 alpha-2)

Max length2

ExampleBG

additionalNationality

Array

Additional nationalities (ISO 3166-1 alpha-2)

Example[ "US", "CA" ]

purposeOfWalletUsage

Array

Purpose of wallet usage

Example[ "Personal Spending", "Online Shopping" ]

otherPurposeOfWalletUsage

string | null

Other purpose of wallet usage (free text field)

Max length255

ExampleCustom purpose

occupationPosition

string | null

Occupation position

Valid values[ "Manager", "Professional", "Technicians and associate professional", "Clerical support worker", "Service and sales worker", "Skilled agricultural, forestry and fishery worker", "Craft and related trades worker", "Plant and machine operator, and assemblers", "Elementary occupation", "NOT APPLICABLE" ]

Max length255

ExampleManager

employmentStatus

string | null

Employment status

Valid values[ "Private sector employee", "Government sector or local authority employee", "Self-employed individual/professional", "Business owner", "Student", "Retired", "Unemployed", "Other (please specify)" ]

Max length255

ExampleEmployed

otherEmploymentStatus

string | null

Other employment status (free text field)

Max length255

ExampleCustom purpose

clientMonthlyNetIncome

string | null

Client monthly net income

Valid values[ "Less than 1000 EUR", "Between 1001 and 5000 EUR", "Between 5001 and 10000 EUR", "Between 10001 and 15000 EUR", "More than 15 000 EUR" ]

Max length255

ExampleBetween 1001 and 5000 EUR

expectedIncomingMonthlyEur

string | null

Expected incoming monthly EUR

Valid values[ "Less than 1000 EUR", "Between 1001 and 5000 EUR", "Between 5001 and 10000 EUR", "Between 10001 and 15000 EUR", "More than 15 000 EUR" ]

Max length255

ExampleBetween 1001 and 5000 EUR

expectedOutgoingMonthlyEur

string | null

Expected outgoing monthly EUR

Valid values[ "Less than 1000 EUR", "Between 1001 and 5000 EUR", "Between 5001 and 10000 EUR", "Between 10001 and 15000 EUR", "More than 15 000 EUR" ]

Max length255

ExampleBetween 1001 and 5000 EUR

typeOfIncomingFunds

Array

Type of incoming funds

Example[ "Domestic (from within client country)", "Intra EU/ЕEA (from within the EU/EEA if the client is in a EU/EAA country)" ]

expectedMonthlyFrequencyIncomingTransfer

string | null

Expected monthly frequency of incoming transfers

Valid values[ "Less than 2 times", "Between 3-5 times", "More than 6 times" ]

Max length255

ExampleBetween 3-5 times

sanctionMediaScreening

boolean | null

Sanction media screening

Examplefalse

riskScore

string | null

Risk score (Low, Medium, High)

Valid values[ "Low", "Medium", "High" ]

Max length100

ExampleLow

vulnerabilityType

string | null

Vulnerability type

ExampleNone

accessibilityRequired

string | null

Accessibility required

ExampleNone

specifiedUsPerson

boolean | null

Specified US person

Examplefalse

company

string | null

Responses

200

Success

{
  "code": 0,
  "data": {
    "token": "82f2211ab813af984b63f28de6ddffc958f485fdb8c7e353"
  }
}

Was this article helpful?