ApiK Y B Screening

Declare a stakeholder (UBO/Director) for screening

Record a related person. Nothing is screened here - the explicit verify call is what creates the Sumsub applicant and runs the AML engine, so declaring somebody the flow never verifies costs nothing.

POST
/api/b/v1/kyb/related-persons

Record a related person. Nothing is screened here - the explicit verify call is what creates the Sumsub applicant and runs the AML engine, so declaring somebody the flow never verifies costs nothing.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Declare a stakeholder for screening.

Naming somebody is not the same as clearing them: nothing is screened here, and the explicit verify call is what creates the Sumsub applicant and runs the AML engine. Declaring somebody the flow never verifies should not cost an applicant.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/kyb/related-persons" \  -H "Content-Type: application/json" \  -d '{    "role": "owner",    "full_name": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "role": "owner",  "full_name": "string",  "date_of_birth": "2019-08-24",  "nationality": "string",  "ownership_percentage": 0,  "identity_status": "pending",  "aml_status": "pending",  "identity_result_code": "string",  "identity_result_text": "string",  "aml_check_id": "febfacf1-571a-4358-b002-e0c8b906c2cf",  "created_at": "2019-08-24T14:15:22Z"}