Upload identity data

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

Important Important: Before using this endpoint, see the integration guide

Path Params
string
required

The unique identifier for the Identity Verification case.

Format: uuid string

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

Tip: This is the same value as the workflowId returned in the Create workflow response. Use this as the case reference number for any questions.

Body Params
person
object

The client’s personal data.

Requirements: For API integration object is required.

address
object

The client’s address details.

Requirements: For API integration that upload person and emailAndPhone data.

emailAndPhone
object

The client’s email address and phone number(s).

Requirements: For API integration object is required.

tax
object

The client’s tax information.
Required in Italy and Portugal

profession
object

The client’s profession and employment situation.

riskRequirements
object

Italian-market risk factors.

deviceMetaData
object

Metadata from the client’s device.

For subsequent requests with the same verificationId, deviceMetaData is merged field by field:
• A provided value replaces the stored value.
• An omitted field or a field set to null keeps the stored value.
• An empty string ("") is stored when the field accepts that value. A field with a format check rejects "". For example, language must be 2 characters, and region must be 2 or 3 characters.
• If deviceMetaData is omitted, the stored deviceMetaData remains unchanged.

person, address, emailAndPhone, tax, profession, and riskRequirements replace the entire stored object. Include all fields that should remain stored.

Important Important: To update geolocation after the SDK or App Component has stored model, send only latitude and longitude. If you include model in the request, for example Chrome, it replaces the stored device model. As a result, the Qualified Electronic Signature device-model check returns selfie_required.

Stored after the SDK or App Component upload:

{
  "deviceMetaData": {
    "model": "iPhone15,2",
    "language": "nl",
    "latitude": "51.00",
    "longitude": "4.00"
  }
}

Your request that only updates geolocation:

{
  "deviceMetaData": {
    "latitude": "52.37",
    "longitude": "4.89"
  }
}

Stored after that request:

{
  "deviceMetaData": {
    "model": "iPhone15,2",
    "language": "nl",
    "latitude": "52.37",
    "longitude": "4.89"
  }
}

Coordinates are updated. model and language stay, because they were not in the request.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json
text/plain