Skip to main content
PATCH
Update a compliance document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

documentId
string
required

Public ID of the compliance document (prefixed with doc_)

Body

application/json
issuedCountry
string
Required string length: 3
issuedDate
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
expiryDate
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
number
string
Maximum string length: 255
Pattern: ^[\x20-\x7E\n]*$
fileId
string
Pattern: ^file.*
description
string
Maximum string length: 255
Pattern: ^[\x20-\x7E\n]*$

Response

A compliance document.

type
enum<string>
required
Available options:
DRIVERS,
ID_CARD,
PASSPORT,
INCOME_SOURCE,
INVESTOR_DOC,
PAYMENT_SOURCE,
RESIDENCE_PERMIT,
OTHER,
PROOF_OF_ADDRESS,
AUTH_LETTER,
UTILITY_BILL,
BANK_STATEMENT,
RENTAL_AGREEMENT,
TAX_DOCUMENT,
VOTER_REGISTRATION_CARD,
BANK_REFERENCE_LETTER,
LEASE_OR_TENANCY_AGREEMENT
subType
enum<string>
required
Available options:
FRONT_SIDE,
BACK_SIDE,
SINGLE_SIDE
issuedCountry
string
required
Required string length: 3
fileId
string
required
Pattern: ^file.*
issuedDate
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
expiryDate
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
number
string
Maximum string length: 255
Pattern: ^[\x20-\x7E\n]*$
description
string
Maximum string length: 255
Pattern: ^[\x20-\x7E\n]*$
userId
string
Pattern: ^usr.*
associatedPartyId
string
Pattern: ^ap.*