Update a Document

Update a Document

PATCH /v1/person/{personId}/document/{documentId}

Update a Document

cURL

curl --request PATCH \
  --url https://qa-api.sbx.solidfi.com/v1/person/{personId}/document/{documentId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "CA license",
  "docType": "drivingLicense",
  "documentNumber": "D123456789",
  "expirationDate": "2025-09-08",
  "issuingCountry": "US",
  "issuingState": "CA",
  "name": "Drivers License"
}
'

200

{
  "createdAt": "2023-11-20T07:07:11Z",
  "description": "CA license",
  "docType": "drivingLicense",
  "documentNumber": "D123456789",
  "expirationDate": "2025-09-08",
  "id": "doc-dcb02cc2-84e0-442e-bba8-180c831de552",
  "issuingCountry": "US",
  "issuingState": "CA",
  "modifiedAt": "2023-11-20T07:09:20Z",
  "name": "Drivers License",
  "personId": "per-e6553324-1db8-49a8-a0d3-29132280b838",
  "status": "active",
  "url": ""
}

Headers

sd-api-key · string

Example:

"{{sd-api-key}}"

sd-person-id · string

Example:

"{{sd-person-id}}"

Path Parameters

personId · string · required

documentId · string · required

Body

application/json

description · string

Example:

"CA license"

docType · string

Example:

"drivingLicense"

documentNumber · string

Example:

"D123456789"

expirationDate · string

Example:

"2025-09-08"

issuingCountry · string

Example:

"US"

issuingState · string

Example:

"CA"

name · string

Example:

"Drivers License"

Response

200 - application/json

Update a Document

createdAt · string

Example:

"2023-11-20T07:07:11Z"

description · string

Example:

"CA license"

docType · string

Example:

"drivingLicense"

documentNumber · string

Example:

"D123456789"

expirationDate · string

Example:

"2025-09-08"

id · string

Example:

"doc-dcb02cc2-84e0-442e-bba8-180c831de552"

issuingCountry · string

Example:

"US"

issuingState · string

Example:

"CA"

modifiedAt · string

Example:

"2023-11-20T07:09:20Z"

name · string

Example:

"Drivers License"

personId · string

Example:

"per-e6553324-1db8-49a8-a0d3-29132280b838"

status · string

Example:

"active"

url · string

Example:

""