Identificationdocumentapiv1

clientKeystring

the encoded key of the client with which this ID document is associated

documentIdstring

the ID

documentTypestring

the type of document, eg. passport, ID card

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472

identificationDocumentTemplateKeystring

the ID template associated with this kind of ID

indexInListnumber

if there is more than one ID document attached to a single entity, this number represents the index in the list of this particular document

issuingAuthoritystring

the institution who provided this ID document, eg, Her Majesty's Passport Authority

toBeDeletedboolean

whether this ID document is marked for deletion

validUntilstring

the last day on which this document can be used

validUntilDTOdate object

Description for validUntilDTOdate in IdentificationDocumentApiV1

dayOfMonthnumber

the day of the month

monthOfYearnumber

the month

yearnumber

the year

Identificationdocumentapiv1

{
  "clientKey": "string",
  "documentId": "string",
  "documentType": "string",
  "encodedKey": "8a19b7057471f4af017472dc0fd80472",
  "identificationDocumentTemplateKey": "string",
  "indexInList": 0,
  "issuingAuthority": "string",
  "toBeDeleted": true,
  "validUntil": "string",
  "validUntilDTOdate": {
    "dayOfMonth": 0,
    "monthOfYear": 0,
    "year": 0
  }
}