Update a document by documentId

put

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/documents/{documentId}

Update an existing document

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

documentId

int64

required

Query Params

performOcr

boolean

Defaults to false

If true, will perform the OCR on uploaded document

returnFullResult

boolean

If true then the document will be returned in the result. If false (default) then only the metadata will be returned

sendNotificationForManualVerification

boolean

Defaults to false

If true, send notification to EDD analyst for manual verification for document. This will only work if the sendNotificationForManualVerification is true

validateDocType

boolean

Defaults to false

If true, verify that the document type matches the uploaded document. This will only work if the performOcr is true

Body Params

awsFaceLivenessSessionId

string

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

base64EncodedDocument

string

required

created

date-time

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

customerId

int64

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

documentId

int64

Unique system generated identifier for a document

documentType

string

enum

required

extraInfo

string

isHistoricalDocument

boolean

lastModified

date-time

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

mediaType

string

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)

organisationId

int64

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

version

int32

required

≥ 0

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.

versionFrom

date-time

versionTo

date-time

Responses

400

Bad Request

200OK