Skip to main content
POST
/
onboarding-cases
/
{caseId}
/
documents
Register a document against an onboarding case
curl --request POST \
  --url https://sandbox-api.finpace.example/v1/onboarding-cases/{caseId}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "documentType": "<string>",
  "fileName": "<string>",
  "storageReference": "<string>",
  "status": "received"
}
'
{
  "documentId": "doc_01JQ9MBT45064X9V5YJ8SQN0BW",
  "documentType": "ubo-proof-of-identity",
  "fileName": "passport.pdf",
  "status": "received",
  "uploadedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 with client credentials for machine integrations and authorization code for delegated user sessions.

Headers

​
Idempotency-Key
string
required

Unique key used to make create and financial action requests safe to retry.

Maximum string length: 80
​
X-Request-Id
string

Caller-generated correlation identifier used for tracing.

Maximum string length: 80

Path Parameters

​
caseId
string
required

Body

application/json
​
documentType
string
required
​
fileName
string
required
​
storageReference
string
​
status
enum<string>
Available options:
received,
validated,
rejected

Response

Document registered

​
documentId
string
Example:

"doc_01JQ9MBT45064X9V5YJ8SQN0BW"

​
documentType
string
Example:

"ubo-proof-of-identity"

​
fileName
string
Example:

"passport.pdf"

​
status
enum<string>
Available options:
received,
validated,
rejected
​
uploadedAt
string<date-time>