Skip to main content
PATCH
Update associated person identity
This endpoint is not yet available in Sandbox or Production.
Update associated person identity verifies that an individual tied to the business is who they claim to be, through a government-issued identity document. More information will be supplied once this endpoint is complete.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

personId
string<uuid>
required

The unique identifier of the associated person.

Body

application/json
type
enum<string>
required

The identity submission type.

Available options:
document-submission
input
object
required

Input of the identity process.

Response

Associated person identity updated successfully.

identity
None · object
required

The identity process for an associated person.