API Reference
System status

Upload identity document metadata (optional)

post
https://api.ext-sandbox.fourthline.com/v2/workflows//clients//documents//metadata

Use this endpoint to upload identity document metadata, such as MRZ or NFC-related fields, for an identity document associated with a documentId in a workflow.

This endpoint enriches a previously uploaded document with structured metadata after document capture.

Note Note:

  • 400 Bad Request returns a validationProblemDetails object, including an errors property that maps request fields to validation error messages.
  • Other 400 responses and 404/422 errors return a problemDetails object containing type, title, status, and detail.
Path Params
uuid
required

The unique identifier of the workflow.

Format: uuid

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

uuid
required

The unique client id assigned to the client by Fourthline.

Format: uuid

Example: baa2bf19-5258-47ec-b428-276d3f045820

uuid
required

The unique identifier of the physical identity document.

Format: uuid

Example: 5c7d8d2b-5dca-4214-aa87-20031889a363

Body Params

The identity document metadata (for example or -related fields) for a document already associated with a documentId in the workflow.

uuid

The unique identifier of the physical identity document.

Requirements: Must match the documentId path parameter.

Format: uuid

Example: 5c7d8d2b-5dca-4214-aa87-20031889a363

string

The number on the physical identity document.

Requirements: When uploading IdentityDocumentMetadata. Otherwise optional.

Example: SPECI2014

string
enum

The specific type or category of the identity document.

Enum:
• Passport
• NationalIDCard
• HealthInsuranceCard
• DrivingLicense
• StudentIDCard
• PaperID
• ResidencePermit
• IbanStatement
• TinReferenceDocument

string

The country that issued the document.

Format: ISO 3166-1 alpha-3

Example: NLD

string

The document expiration date.

Format: yyyy-mm-dd

Example: 2030-11-15

string

The document issue date.

Format: yyyy-mm-dd

Example: 2021-01-01

boolean

Whether this is the client’s primary identity document.

nfcDataGroups
array of objects

The NFC data groups read from the document chip. Each entry contains the data group number and the extracted chip data (for example, DG1 MRZ, DG2 portrait).

nfcDataGroups
sdkAuthenticationChecks
object

The cryptographic authentication checks performed during the NFC read. See SdkAuthenticationChecks for supported check types.

Headers
string
required
Defaults to Bearer <access_token>

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

string
Defaults to no-cache

To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to no-cache.

Responses
200

Returned when the metadata is stored successfully. The response body is empty.

Updated 4 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 4 months ago