Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Identity Verification UK

Upload client data

Use this endpoint to upload a client’s personal data for an UK Identity Verification case. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: Before using this endpoint, see: <br />• Create workflow <br />• <a href="https://docs.fourthline.com/docs/uk-integration">Integration guide</a>

post/v1/UkIdentityVerification/{workflowId}/client

Path parameters

workflowIdstring required

Our unique identifier for the workflow, returned in the Create workflow response. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: Use this as the reference number for any questions.

Headers

Authorizationstring required

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

Request body

firstNamestring required

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

lastNamestring required

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

birthDatestring date required

The client’s date of birth. <br /><br />Format: Date YYYY-MM-DD <br /><br />Example: 1990-05-15

gender'Male' | 'Female' | 'Other' | 'Unknown' required

The client’s sex. <br /><br />Format: Case sensitive <br /><br />Example: Female <br />Enum: <br />• Female: Female in line with ID document <br />• Male: Male in line with ID document <br />• Other: ID document contains a value other than Male or Female <br />• Unknown: ID document contains no gender field

citizenshipstring required

The country or countries where the client has citizenship. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: UK

placeOfBirthstring required

The city where the client was born. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Manchester

Response

Client data uploaded

object required

The resource was created successfully. The response body is empty.