Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Identity Verification

Get client profile

Use this endpoint to get the profile of an Identity Verification client, using the Fourthline clientId.

get/v1/clients/{clientId}

Path parameters

clientIdstring required

Our unique identifier for the client, returned in the Create workflow response. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Headers

Authorizationstring required

The access_token returned in your most recent Create access token response.

Response

Client profile returned

clientIdstring

Our unique identifier for the client, returned in your first Create workflow request for this client. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

providerClientIdstring

Your unique identifier for the client. <br /><br />Format: No set format <br /><br /> <img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>Tip: This is the same value as your ClientNumberProvider.

countryCodestring

The code of the client’s country of residence.

clientTypeinteger

The type of client: <br />• 0: The client is a natural person. <br />• 1: The client is a legal entity.

companyNamestring

The name of the client’s company.

firstNamestring

The client’s first name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: John

lastNamestring

The client’s last name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Smith

sourcestring

How the client came in contact with you: <br />• direct_channel: The client contacted you directly. <br />• referral: The client was referred to you by another client. <br />• search_engine: The client found you online via a search engine.

referencedByClientIdstring

Your identifier for the other client who referred this client to you.

riskProfileinteger

The client’s risk score, or if not yet available 0.

clientStatusstring

The current status of the client: <br />• new: The client profile has been created. <br />• active: The client was accepted. <br />• inactive: The client was rejected.

creationUtcDateTimestring

The timestamp for when the client profile was created <br /><br />Format: ISO 8601 UTC date and time

updateUtcDateTimestring

The timestamp for when the client profile was last updated. <br /><br />Format: ISO 8601 UTC date and time

versionstring

The version of the client profile. <br />Always returns the value 20171015.