Add a person(holder/UBO)

post

https://sandbox-api-v2.dogpay.com/open-api/v1/entities/business-kyc/add-person

During rejection remediation for business KYC, if the status is 'request', a person can be added. This action creates a new personId (without a full KYC rebuild), attaches a FACE_BIOMETRIC rejection record, and requires a biometric-url and GREEN status before review.

👉 Business KYC Rejection and Resubmission Guide

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

rejectionRecordId

string

Optional pending HOLDER_INFO / BENEFICIAL_OWNER_INFO rejection record to mark done after person is created (targetId may be empty)

role

string

enum

required

BENEFICIAL_OWNER = UBO; HOLDER = authorized/contact style holder (not a second signer)

Allowed:

givenName

string

required

Given name

middleName

string

Middle name

surname

string

required

Surname

birthDate

string

required

Birth date (YYYY-MM-DD)

nationality

string

enum

required

Issuing Country Code

countryOfBirth

string

enum

required

Issuing Country Code

sex

string

enum

required

Gender

Allowed:

soc

string

enum

required

👉 SOC Code Reference

idNumber

string

required

ID number

idType

string

enum

required

Identity document type enumeration.

passport: Passport
cn_ric: China Resident Identity Card
Hk_hkid: Hong Kong Identity Card (HKID)
driver_license: Driver's License
sg_nic: Singapore National Identity Card (NIC)
identity: Identity Card (generic)
other: Other ID Types

Allowed:

startDate

string

required

Role / ID start date (YYYY-MM-DD)

expirationDate

string

ID expiration date when required by idType

address

object

required

Address

poaFileId

string

required

Proof-of-address file id

percentageOfShares

number

Share percentage (required for BENEFICIAL_OWNER)

Headers

dgp-entity-id

string

required

The unique identifier of the target entity. Mandatory for white-label customers to define the sub-entity context.

Response

Language

Credentials

Bearer

Loading…

Response

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

application/json

200