Update a Document

Update a document for a Beneficiary, Customer Account, or Business Account. You can change the document details (except documentType, extension, and contentLength) and upload a new version of the document.

Updating a document involves two steps:

Send a request with the document ID and (optionally) the changes to the document details.
Optionally, upload the document by calling the content URL provided in the response.

Endpoint

PUT /v1/documents/{documentId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

documentId REQUIRED

string

Semantic ID of the document. Example: kor-privacy-policy

Request Body

documentType

string enum, values: driving-license, passport, formation, tax, ownership, other

Type of document. The following values are supported:

driving-license Driver’s license. Can be added for Individual Customers and Beneficiaries.
passport Passport. Can be added for Individual Customers and Beneficiaries.
formation Formation document. Can be added for Business Customers.
tax Tax document. Can be added for Business Customers.
ownership Ownership document. Can be added for Business Customers.
other Other type of document. Can be added for Individual Customers, Business Customers, Beneficiaries, and Business Accounts.

name

string

Name of the document. Example: Bob Smith Driver’s License

description

string

Description of the document.

number

string

Document number. Required if documentType is driving-license.

issuingDate

string (date)

Date the document was issued. Cannot be a future date.

issuingCountryCode

string, min length: 2, max length: 3

Country where the document was issued. Must be an ISO 3166-1 uppercase alpha 2-character or 3-character country code. For example, the United States is US or USA. Required if documentType is driving-license.

issuingStateCode

string, min length: 2, max length: 3

State or province where the document was issued. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO. Required if documentType is driving-license.

expiryDate

string (date)

Expiry date for the document. Required if documentType is driving-license.

metadata

string, max items: 5, value max length: 1024

Use a maximum of 5 key/value pairs to store additional information about the document.

Returns

Returns the Document object. This object contains the document details, including a unique ID for the document and a content URL. You can upload a new version of the document by calling the content URL with an HTTP PUT request.

SAMPLE REQUEST

				
					{
  "documentType": "driving-license",
  "name": "John Doe Driving License",
  "description": "driving license",
  "number": "123-456-789",
  "issuingDate": "2022-02-03",
  "issuingCountryCode": "US",
  "issuingStateCode": "NY",
  "expiryDate": "2024-02-03",
  "metadata": {
    "docRefId": "100000333"
  }
}

SAMPLE RESPONSE

				
					{
  "id": "b175994b-fd5b-46d6-aba9-73638902f4a0",
  "businessAccountId": "733df8ac-5d93-4e5a-b665-36a1525353d8",
  "holderId": "4b79e405-959e-41b5-92c5-1f49e6b71745",
  "holderType": "CUSTOMER",
  "documentType": "driving-license",
  "name": "John Doe Driving License",
  "description": "driving license",
  "number": "123-456-789",
  "issuingDate": "2022-02-03",
  "issuingCountryCode": "US",
  "issuingStateCode": "NY",
  "extension": "JPG",
  "contentLength": 81169,
  "version": "string",
  "expiryDate": "2024-02-03",
  "url": {
    "value": "https://documents.rocketkor.net/7260554c5",
    "allowed": "GET",
    "expiresIn": 600
  },
  "status": "NEW",
  "metadata": {
    "docRefId": "100000333"
  },
  "createdBy": {
    "id": "c503092d-e6c4-4f7a-b893-46ebe56b18a8",
    "type": "service-account"
  },
  "createdAt": "2023-05-03T23:11:59.656Z",
  "updatedBy": {
    "id": "c503092d-e6c4-4f7a-b893-46ebe56b18a8",
    "type": "service-account"
  },
  "updatedAt": "2023-06-05T23:11:59.656Z"
}