Skip to main content
PATCH
Update an application (draft data only; never changes status)

Authorizations

Authorization
string
header
required

Enter Auth0 JWT token

Path Parameters

id
string<uuid>
required

Body

application/json
applicant
object
businessActivity
object
businessInfo
object
hasIndirectControl
boolean
indirectControlDetails
string
individualActivity
object
persona
enum<string>
Available options:
sme,
large_corp,
licensed_fi

Response

accountId
string<uuid>
required

The account this application belongs to (self or sub-account).

applicationType
enum<string>
required
Available options:
business,
individual
createdAt
string<date-time>
required
id
string<uuid>
required
status
enum<string>
required
Available options:
draft,
under_review,
approved,
more_info_requested,
rejected
editableSections
string[]

When status is more_info_requested, the sections you may edit and resubmit. applicant / businessInfo / businessActivity / individualActivity are edited via PATCH; persons via the /persons sub-resource (and covers that person’s own documents); documents is company-level documents via the /documents sub-resource. Empty otherwise.

moreInfoReason
string

When status is more_info_requested, the reviewer’s notes describing what needs to change. Null otherwise.

registeredName
string

The name the company is registered under, so a directory can label an application without reading the full record.

riskLevel
enum<string>
Available options:
low,
medium,
high,
prohibited
screeningStatus
enum<string>
Available options:
pending,
in_progress,
clear,
flagged,
failed,
timed_out