Submit KYB Pack for a business entity

post

https://sandbox-compliance.api.reap.global/entity/{entityId}/ukyb

Submits the complete KYB for a business entity: the base pack (legal name, legal form, registration number, UBO declaration, registered address, principal place of business address, optional website, line of business, optional date of incorporation), with the due-diligence questionnaire and enhanced-diligence declarations optionally nested under ddq and edd. Use PATCH to amend an existing payload before submission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityId

uuid

required

The unique identifier (UUID) of the business entity.

Body Params

Structured KYB Pack payload. The questionnaire and enhanced-diligence sections may be nested under ddq and edd to submit everything in one call.

legalBusinessName

string

required

length between 1 and 200

Full legal registered name, exactly as shown on the Certificate of Incorporation.

legalFormOfCompany

string

enum

required

Controlled list of legal entity forms.

businessRegistrationNumber

string

required

length between 1 and 100

Government-issued business registration number.

uboDeclaration

array of objects

required

length between 1 and 50

Ultimate Beneficial Owners with 25%+ ownership or control. At least one entry is required — an empty array is rejected. Supplying this field replaces the whole set; omit it on a PATCH to leave the existing owners untouched.

uboDeclaration*

An Ultimate Beneficial Owner of the business, carrying full KYC. Every field is required — a partially-populated owner is rejected, with all gaps reported together. Each declared owner is created as its own individual entity; the returned uboEntities[].entityId is what identity documents for that person must be uploaded against. Submitting this array replaces the entire previously declared set: every owner is recreated with a new entityId, and any documents previously uploaded against the old ids are removed. Re-upload after every submission that includes this field.

externalUserId

string

required

length between 1 and 100

Required. Your own identifier for this person. Echoed back in the response so you can correlate owners without relying on array order.

ownershipPct

number

required

0 to 100

Ownership percentage as a decimal between 0 and 100. Represented as a percentage (60 = 60%), not a fraction. Stored to two decimal places.

identity

object

required

Every field is required for every declared owner. middleName is the only optional field.

document

array of objects

required

length between 1 and 3

Required. Between 1 and 3 identity documents per owner. Replaced wholesale on PATCH, never merged entry by entry.

document*

documentCategory

string

enum

required

Always IDV — a beneficial owner’s document establishes identity, not address.

Allowed:

type

string

enum

required

The kind of identity document. Must equal the uboDocumentType sent when this owner’s document is uploaded — submission compares the two.

Allowed:

number

string

required

length between 1 and 50

country

string

required

length between 3 and 3

issuingDate

date

expiryDate

date

address

object

required

registeredAddress

object

required

The address on record with the company registrar (the Certificate of Incorporation address).

principalPlaceOfBusinessAddress

object

required

Where the business actually trades. May differ from registeredAddress.

businessWebsiteUrl

uri

length ≤ 500

Optional business website URL.

validEmailDomains

array of strings

required

length between 1 and 10

Email domains whose employees may be issued cards for this business. Required — at least one, at most 10. Each entry must be a bare domain name such as acme.example: no scheme, path, @ or whitespace. Values are normalised (lowercased, a leading www. removed) and de-duplicated, so the stored list may be shorter than the one submitted. Supplying this field replaces the whole list.

validEmailDomains*

lineOfBusiness

string

enum

required

Controlled business-classification code.

dateOfIncorporation

date

required

Date the business was incorporated (YYYY-MM-DD). Must not be in the future.

ddq

object

Optional Due Diligence Questionnaire, submitted in the same call.

edd

object

Optional Enhanced Due Diligence declarations, submitted in the same call.

200The KYB Pack has been successfully submitted for the entity.

400The payload was rejected. Every problem found across the pack, questionnaire and enhanced-diligence sections is listed together, so a client can fix them in one pass rather than resubmitting to discover the next.

403Forbidden | Missing authentication

409A KYB Pack has already been submitted for this entity. Use PATCH /ukyb to amend it.

500Internal server error