Document Update

put

https://api.infinant.com/interlace/documents-api/v1/documents/{documentId}

Update a document

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

documentId

string

required

length ≤ 256

Document identifier

Body Params

The data of the document to be updated

name

string

required

length ≤ 128

The name of the document or file

description

string

length ≤ 256

The description of the document or file

docType

string

required

length ≤ 128

Document type (BankStatement, BusinessFormation, Identification, Utility)

presigned

boolean

If true, returns pre-signed url

documentFile

string

Document content base-64 encoded. If presigned=true, this is not required

mimeType

string

enum

required

Document mime type

appRefId

string

length ≤ 128

Reference id associated with KYC check performed outside of this API. It's optional if the intent is perform KYC in create customer flow

customerId

string

length ≤ 128

Customer id

accountId

string

length ≤ 128

Account id

transactionId

string

length ≤ 128

Transaction id

mcid

string

length ≤ 128

Document mcid

stopPaymentId

string

length ≤ 128

Stop Payment id

loanPoolNbr

string

length ≤ 128

Loan Pool Number

reportId

string

length ≤ 128

Report id

infoContent

string

For future use

Headers

x-rquid

uuid

required

Unique request identifier - UUID

x-userid

string

To identify end-user on client authenticated request

x-idempotency-key

string

required

length ≤ 256

Used to de-duplicate requests- UUID

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Document updated

400Bad request