Update an application's submitter details

PATCH

/api/v1/applications/{id}/submitter

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

Request Body^required

Media type application/json

object

firstName

required

string

lastName

required

string

email

required

string

phoneNumber

Three-way, because “leave it alone” and “clear it” are different instructions and a two-way field cannot say both: OMITTED keeps whatever is stored (and carries it onto a fork), null clears it, an object sets it.

object

countryCode

required

string

phoneNumber

required

string

role

The contact’s role, free text (e.g. Authorised signatory). Three-way like phoneNumber: OMITTED keeps whatever is stored, null or blank clears it, a string sets it. Prefilled on the periodic review’s declaration.

string

nullable <= 200 characters

capacity

The contact’s capacity, free text (e.g. Director). Three-way like role.

string

nullable <= 200 characters

resend

Re-send the onboarding link to the updated email after saving. Works regardless of application status.

boolean

Examples

{
  "firstName": "",
  "lastName": "",
  "email": "",
  "phoneNumber": {
    "countryCode": "+1",
    "phoneNumber": "4143319681"
  },
  "resend": false
}

{
  "firstName": "Michael",
  "lastName": "Chen",
  "email": "michael.chen@example.com",
  "phoneNumber": {
    "countryCode": "+1",
    "phoneNumber": "4143319681"
  },
  "role": "string",
  "capacity": "string",
  "resend": false
}

Responses

200

Submitter details updated

Media type application/json

object

firstName

required

string

lastName

required

string

email

required

string

phoneNumber

object

countryCode

required

string

phoneNumber

required

string

role

The contact’s role, free text.

string

nullable

capacity

The contact’s capacity, free text.

string

nullable

inviteEmail

Present only when resend was true

object

status

required

string

Allowed values: SENT FAILED

failureCode

string

Allowed values: INACTIVE_RECIPIENT

reason

string

Examples

{
  "firstName": "Michael",
  "lastName": "Chen",
  "email": "michael.chen@example.com",
  "phoneNumber": {
    "countryCode": "+1",
    "phoneNumber": "4143319681"
  },
  "role": "Authorised signatory",
  "capacity": "Director"
}

{
  "firstName": "Michael",
  "lastName": "Chen",
  "email": "michael.chen@acme-corp.com",
  "phoneNumber": {
    "countryCode": "+1",
    "phoneNumber": "4143319681"
  },
  "role": "Authorised signatory",
  "capacity": "Director",
  "inviteEmail": {
    "status": "SENT",
    "failureCode": "INACTIVE_RECIPIENT",
    "reason": "We couldn't send the onboarding email to this address"
  }
}