Submit onboarding data

post

https://api.mercury.com/api/v2/submit-onboarding-data

Submit onboarding data for applicants to pre-fill their Mercury application

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

about

object | null

applicationType

string | null

enum

Allowed:

beneficialOwners

array of objects

required

length ≥ 1

beneficialOwners*

address1

string | null

Address line 1 of Beneficial Owner's address

address2

string | null

Address line 2 of Beneficial Owner's address

citizenshipStatus

string | null

enum

Beneficial Owner's Citizenship Status

Allowed:

city

string | null

City of Beneficial Owner's address

country

string | null

Country of Beneficial Owner's address

dateOfBirth

date | null

Beneficial Owner's Date of Birth

string | null

Beneficial Owner's Email Address

firstName

string | null

Beneficial Owner's First Name

identificationBlob

string | null

Beneficial Owner's Identification File

identificationType

string | null

enum

Beneficial Owner's Identification File Type

Allowed:

isPep

string | null

enum

Beneficial Owner's pep status

Allowed:

jobTitle

string | null

enum

Beneficial Owner's Job Title

lastName

string | null

Beneficial Owner's Last Name

otherJobTitle

string | null

Beneficial Owner's Alternate Job Title

percentOwnership

number | null

Beneficial Owner's Ownership Percentage

phoneNumber

string | null

Beneficial Owner's Phone Number

postalCode

string | null

Postal Code of Beneficial Owner's address

region

string | null

Region or State of Beneficial Owner's address

socialProfileLinks

array of strings | null

Beneficial Owner's Social Profile Websites

socialProfileLinks

state

string | null

State or Region of Beneficial Owner's address (Deprecated)

businessContactDetails

object | null

businessLegalAddress

object | null

businessPhysicalAddress

object | null

formationDetails

object | null

inviteEmail

string | null

partner

string

required

webhookURL

string | null

Headers

Authorization

string

required

Mercury API Key

Responses

400

Invalid body or Authorization

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200