Upload client data

Use this endpoint to upload a client’s personal data for an UK Identity Verification case.

Important Important: Before using this endpoint, see:
• Create workflow
• Integration guide

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Our unique identifier for the workflow, returned in the Create workflow response.

Format: uuid string

Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Tip: Use this as the reference number for any questions.

Body Params
string
required

The client’s first name.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: John

string
required

The client’s last name.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: Smith

date
required

The client’s date of birth.

Format: Date YYYY-MM-DD

Example: 1990-05-15

string
enum
required

The client’s sex.

Format: Case sensitive

Example: Female
Enum:
• Female: Female in line with identity document
• Male: Male in line with identity document
• Other: identity document contains a value other than Male or Female
• Unknown: identity document contains no gender field

Allowed:
string
required

The country or countries where the client has citizenship.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: UK

string
required

The city where the client was born.

Format: Alphabetical characters, spaces, hyphens, and apostrophes

Example: Manchester

address
object
required
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json