Skip to main content

IdentityDocumentList

List of identity documents.

    identityDocuments

    object

    Personal identity document

    id string
    customerId stringrequired

    Possible values: <= 20 characters

    type stringrequired

    Possible values: [PASSPORT, DRIVERS_LICENSE, ID_CARD, GOVERNMENT_NATIONAL_ID]

    documentNumber stringrequired
    expirationDate date
    countryCode stringrequired

    Possible values: >= 2 characters and <= 2 characters

    meta

    object

    Contains paging information regarding the returned records, when response is paginated.

    The input for paginated query contains two parameters:

    • limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
    • offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

    Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

    The number of previous pages can be calculated by dividing offset to limit.

    numberOfRecords integer

    This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

    limit integer

    This is the requested number of records to be returned per page.

    offset integer

    This is the requested starting position of the response, where 0 is the first record.

    page integer

    This is the page of records on which the lookup starts. The starting page is 1.