API Reference

Create a new User Assessment

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

This endpoint is used to assess a User. Depending on what information is available on the User, a tier level will be assigned to the assessment, the higher the level is, the more permission he will get on your platform. Please refer to PTI documentation for more information on the tier levels configuration and scenarios.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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
string
length between 1 and 1
^[0129MmfFoOnNuU]

ISO/IEC 5218 / vCard4

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

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.

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:
string
enum

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

tags
array of objects
length ≤ 100

Tag that characterizes the User. Used for internal classification purposes.

tags
Allowed:
paymentInformation
array of objects
length ≤ 100
paymentInformation
string
length ≤ 255
^[ -~]*$
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)

double
0 to 999999

The value of the transaction that the User is intending to perform in USD

ptiMeta
object

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

clientMeta
object

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

Headers
string
required
length ≤ 64
^[a-z0-9_-]{3,64}$

Unique identifier of the request. This ID must be provided and stored by the client of this API at the creation of a transaction. This ID is attached to all PTI internal operations as well as the webhook calls. This ID is required to post feedback about a transaction and get support from PTI for a problem on a transaction. Creating two transactions having the same requestId is not allowed.

string
required
length ≤ 64
^[a-z0-9_-]{3,64}$

Represents a User action under which transaction amounts will accumulated and will control the User Assessment requirements. The values this header can take must be agreed upon and communicated to PTI. Setting unknown values here will generate an error.

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

Session ID associated to a UI session for a specific User. Should match the value passed to the PTI SDK at initialization.

boolean

Set to true to disable webhook calls for this request.

Responses

429

Too many requests

Callback

Updated 10 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?