Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
d) Customer Management

Get list of the customers documents

This will return all documents linked to the customer. If the includeHistoricalDocument=true, it will include the historical document of users. If the includeInvalidDocument=true, it will include the invalid document of users

get/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/documents

Path parameters

tenantIdinteger required
customerIdinteger required

Query parameters

fieldsstring

Fields to be included. By default returs all fields. Specify onlyMetaData to receive metadata without document

includeHistoricalDocumentboolean
includeInvalidDocumentboolean

If true, will return up to 3 invalid uploaded documents for each document type

Response

OK

awsFaceLivenessSessionIdstring

Deprecated. Use extraInfo to pass Aws session Id for initiating AWS Face Liveness Check

base64EncodedDocumentstring required
createdstring date-time

ISO 8601 date/time of when the record was first created

customerIdinteger

The customer the document is for. One of customerId or organisationId must be provided

documentIdinteger

Unique system generated identifier for a document

documentType'AFFIDAVIT' | 'ASYLUM_PAPERS' | 'AUTO' | 'BACK_OF_ADDITIONAL_IDENTITY' | 'BACK_OF_DRIVERS_LICENSE' | 'BACK_OF_NATIONAL_IDENTITY' | 'BANK_STATEMENT' | 'BIRTH_CERTIFICATE' | 'BUSINESS_LICENSE' | 'CERT_OF_INCORP' | 'CERT_OF_REGISTRATION' | 'COMPARISON_ASYLUM_PAPERS' | 'COMPARISON_FACIAL_PHOTO' | 'COMPARISON_NATIONAL_DATABASE' | 'COMPARISON_NATIONAL_IDENTITY' | 'COMPARISON_PASSPORT' | 'DRIVERS_LICENSE' | 'ENHANCED_DUE_DILIGENCE' | 'FACIAL_PHOTO' | 'FOREIGN_CERTIFICATE' | 'LOGO' | 'NATIONAL_IDENTITY' | 'OTHER_SOURCE_OF_WEALTH' | 'PARTNERSHIP_DEED' | 'PASSPORT' | 'PERMIT' | 'PROOF_OF_ADDRESS' | 'PROOF_OF_BUSINESS_OWNERSHIP' | 'PROOF_OF_CRYPTO_HOLDINGS' | 'PROOF_OF_FUNDS' | 'PROOF_OF_GIFTS_DONATIONS' | 'PROOF_OF_INHERITANCE' | 'PROOF_OF_INVESTMENTS' | 'PROOF_OF_NON_COUNTRY_OF_TAXATION_TAX_RESIDENCY' | 'PROOF_OF_NON_US_TAX_RESIDENCY' | 'PROOF_OF_SALARY_EMPLOYMENT_INCOME' | 'PROOF_OF_SALES_OF_ASSETS' | 'PROOF_OF_WINNINGS' | 'TAX' | 'TEMPORARY_IDENTITY' | 'TEMPORARY_IDENTITY_RECEIPT' | 'TEMP_RESIDENCY_PERMIT' | 'TRUST_DEED' | 'USA_W_8' | 'USA_W_9' | 'VISA' | 'WORK_PERMIT' required
extraInfostring
isHistoricalDocumentboolean
lastModifiedstring date-time

ISO 8601 date/time of when the record was last modified

mediaTypestring required

Supported media types are image/jpeg and image/png for anything that needs facial recognition and in addition application/pdf is supported for documents that only need OCR (e.g. proof of address)

organisationIdinteger

The organisation the document is for. One of customerId or organisationId must be provided

versioninteger required

A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.

versionFromstring date-time
versionTostring date-time

Example response

[
  {
    "created": "2022-03-10T12:15:50-04:00",
    "lastModified": "2022-03-10T12:15:50-04:00",
    "versionFrom": "2022-03-10T12:15:50-04:00",
    "versionTo": "2022-03-10T12:15:50-04:00"
  }
]