Create a User

post

https://api.staging.fiant.io/v1/users

Creates a new user under the client account. The request must include all
required user information in the request body.

After a user is created, your system can receive real-time status updates
through the provided callback URL. These callbacks notify your server of
important changes to the user’s lifecycle (e.g., activation, deactivation,
or verification status).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

Type of User which represents the legal entity involved in the API action

Allowed:

addresses

array of objects

length ≤ 100

addresses

piis

array of objects

length ≤ 5000

piis

emails

array of objects

length ≤ 100

emails

devices

array of objects

length ≤ 100

devices

phones

array of objects

length ≤ 100

phones

name

object

gender

string

length between 1 and 1

^[0129MmfFoOnNuU]

ISO/IEC 5218 / vCard4

dateOfBirth

string

length ≤ 10

^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])$

ISO 8601

countryOfCitizenship

string

length ≤ 200

^([A-Za-z][A-Za-z],?)+

Comma separated list of ISO 3166 alpha 1 country codes

string

required

length ≤ 255

^[a-z0-9_-]{3,255}$

Unique identifier for this User. This value MUST be chosen and stored at User creation time.

status

string

enum

Status of the User. Only ACTIVE Users can appear in API calls. Calls containing INACTIVE or BLOCKED Users will result in an error. The status cannot be set via API calls that create or update Users. If it is passed in User creation or modification calls, it will be silently ignored.

Allowed:

statusReason

string

enum

Reason explaining why the status is BLOCKED or INACTIVE. Same rules as the status field apply.

tags

Allowed:

paymentInformation

array of objects

length ≤ 100

paymentInformation

sourceOfFunds

string

length ≤ 255

^[ -~]*$

userCreationDate

string

length ≤ 40

^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-][01]\d:[0-5]\d)

Optional ISO-8601 value. Used to provide the date the User was created in your system. If left empty, it will be populated at current time.

userPtiMeta

object

key/value map of extra meta data for this request (used by PTI)

userClientMeta

object

key/value map of extra meta data for this request (used by Client)

Headers

x-pti-client-id

string

required

length ≤ 64

^[a-z0-9_-]{3,64}$

Client ID provided to you during onboarding.

Responses

429

Too many requests

Callback

201Successfully added User

400Missing required fields on User

401unauthorized

409User already exist

defaultunexpected error