Skip to main content
POST
/
onboarding-cases
Start an onboarding case
curl --request POST \
  --url https://sandbox-api.finpace.example/v1/onboarding-cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "partyId": "<string>",
  "journeyType": "digital",
  "productCodes": [
    "<string>"
  ],
  "sourceChannel": "<string>"
}
'
{
  "caseId": "obc_01JQ9MA6M4WQR1J53ANQ4F1ZE6",
  "partyId": "<string>",
  "journeyType": "digital",
  "productCodes": [
    "<string>"
  ],
  "status": "draft",
  "kycStatus": "not-started",
  "assignedQueue": "sme-onboarding-review",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "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

Body

application/json
​
partyId
string
required
​
journeyType
enum<string>
required
Available options:
digital,
assisted,
partner
​
productCodes
string[]
required
​
sourceChannel
string

Response

Onboarding case created

​
caseId
string
Example:

"obc_01JQ9MA6M4WQR1J53ANQ4F1ZE6"

​
partyId
string
​
journeyType
enum<string>
Available options:
digital,
assisted,
partner
​
productCodes
string[]
​
status
enum<string>
Available options:
draft,
in-review,
awaiting-documents,
pending-approval,
approved,
declined,
completed
​
kycStatus
enum<string>
Available options:
not-started,
pending,
passed,
failed,
manual-review
​
assignedQueue
string
Example:

"sme-onboarding-review"

​
createdAt
string<date-time>
​
updatedAt
string<date-time>