PATCH
/
v1
/
business
/
{businessId}
/
document
/
{documentId}
curl --request PATCH \
  --url https://qa-api.sbx.solidfi.com/v1/business/{businessId}/document/{documentId} \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "formation",
  "docType": "formation",
  "documentNumber": "FM12345",
  "expirationDate": "2028-03-11",
  "issuingCountry": "Canada",
  "issuingState": "Alberta",
  "name": "JohnDoe"
}'
{
  "businessId": "bus-a4c781d1-abf2-4030-bc70-d860cf164013",
  "createdAt": "2023-11-20T07:46:58Z",
  "description": "formation",
  "docType": "formation",
  "documentNumber": "FM12345",
  "expirationDate": "2028-03-11",
  "id": "doc-fa191088-1cc8-49e0-9ff3-2f51a773ddfe",
  "issuingCountry": "Canada",
  "issuingState": "Alberta",
  "modifiedAt": "2023-11-20T07:47:43Z",
  "name": "JohnDoe",
  "status": "active",
  "url": ""
}

Headers

​
sd-api-key
string
Example:

"{{sd-api-key}}"

​
sd-person-id
string
Example:

"{{sd-person-id}}"

Path Parameters

​
businessId
string
required
​
documentId
string
required

Body

application/json
​
description
string
Example:

"formation"

​
docType
string
Example:

"formation"

​
documentNumber
string
Example:

"FM12345"

​
expirationDate
string
Example:

"2028-03-11"

​
issuingCountry
string
Example:

"Canada"

​
issuingState
string
Example:

"Alberta"

​
name
string
Example:

"JohnDoe"

Response

200 - application/json
Update Document
​
businessId
string
Example:

"bus-a4c781d1-abf2-4030-bc70-d860cf164013"

​
createdAt
string
Example:

"2023-11-20T07:46:58Z"

​
description
string
Example:

"formation"

​
docType
string
Example:

"formation"

​
documentNumber
string
Example:

"FM12345"

​
expirationDate
string
Example:

"2028-03-11"

​
id
string
Example:

"doc-fa191088-1cc8-49e0-9ff3-2f51a773ddfe"

​
issuingCountry
string
Example:

"Canada"

​
issuingState
string
Example:

"Alberta"

​
modifiedAt
string
Example:

"2023-11-20T07:47:43Z"

​
name
string
Example:

"JohnDoe"

​
status
string
Example:

"active"

​
url
string
Example:

""

Delete a DocumentGet Document Upload URL