Identificationdocument

An Id document represents a document that can be used to identify a person like a passport, a drivers license an id card etc.

attachments object[]

A list containing information about the attached files for this document

Array [

creationDatestring<date-time>

The creation date of the document, stored as UTC

Example: 2016-09-06T13:37:50+03:00

encodedKeystring

The document encodedKey

fileNamestring

The original file name of the document

fileSizeinteger<int64>

The file size of the document

idinteger<int64>required

The document id

lastModifiedDatestring<date-time>

The last modified date of the document, stored as UTC

Example: 2016-09-06T13:37:50+03:00

locationstring

Location where the document can be found, eg /myfiles/mypicture.jpeg

namestringrequired

The name of the document

notesstring

Detailed notes about the document

ownerKeystring

Represents the holder of this document. If null, means nobody is the owner of this document

ownerTypestring

Determines the owner type of the document

Possible values: [CLIENT, GROUP, LOAN_PRODUCT, SAVINGS_PRODUCT, CENTRE, BRANCH, USER, LOAN_ACCOUNT, DEPOSIT_ACCOUNT, ID_DOCUMENT, LINE_OF_CREDIT, GL_JOURNAL_ENTRY]

typestringrequired

The extension of the document

]

clientKeystring

The encoded key of the client that owns this document

documentIdstringrequired

The id of the document

documentTypestringrequired

The type of the document, Passport, Id card Drivers license, etc.

encodedKeystring

The encoded key of the document, generated, unique

identificationDocumentTemplateKeystring

Encoded key of the template used for this document

indexInListinteger<int32>

This document's index in the list of documents

issuingAuthoritystring

Authority that issued the document, eg. Police

validUntilstring<date>

Date when the validity of the document ends

Example: 1987-04-26

Identificationdocument

{
  "attachments": [
    {
      "creationDate": "2016-09-06T13:37:50+03:00",
      "encodedKey": "string",
      "fileName": "string",
      "fileSize": 0,
      "id": 0,
      "lastModifiedDate": "2016-09-06T13:37:50+03:00",
      "location": "string",
      "name": "string",
      "notes": "string",
      "ownerKey": "string",
      "ownerType": "CLIENT",
      "type": "string"
    }
  ],
  "clientKey": "string",
  "documentId": "string",
  "documentType": "string",
  "encodedKey": "string",
  "identificationDocumentTemplateKey": "string",
  "indexInList": 0,
  "issuingAuthority": "string",
  "validUntil": "1987-04-26"
}