Skip to main content
PATCH
cURL

Update Document Information

Update Limit: KYC information can be updated a maximum of 3 times per customer. Once this limit is reached, no further updates will be allowed.

Error Codes and Messages

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
customer_id
string<uuid>
required

Zapyd customer ID (UUID) returned by Create Customer.

Example:

"4e6f1b20-a73c-11ec-b909-0242ac120002"

full_address
string
required

Residential address.

Example:

"FULL_ADDRESS_OF_THE_CUSTOMER"

document_type
string
required

Document type as returned by /kyc/configuration/{customer_id} (e.g. PASSPORT, etc.)

document_details
object
required

Required. Must include document_number.

document_front_image_url
string<uri>

Front image URL (JPG, JPEG, PNG or PDF). Required for every document type except AADHAAR, which accepts either both images or aadhaar_json / aadhaar_xml in document_details.additional_data.

document_back_image_url
string<uri>

Back image URL (JPG, JPEG, PNG or PDF). Same rule as document_front_image_url.

Response

Document information updated successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object