Skip to main content

Create KYC Group

Creates a new KYC group in the system.

Request

POST /v2/admin/kyc/groups

Parameters

NameTypeInDescription
namestringbodyRequired. The name of the KYC group

Headers

NameDescription
AuthorizationRequired. Bearer token for authentication
Content-TypeRequired. Must be application/json

Request Body

{
"name": "Premium Investors"
}

Example

curl --request POST \
--url '{{baseUrl}}/v2/admin/kyc/groups' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/json' \
--data '{
"name": "Premium Investors"
}'

Response

A successful request returns an HTTP 201 status code with the action response.

{
"requires_approval": false,
"completed": true
}

Response Fields

FieldTypeDescription
requires_approvalbooleanWhether the action requires approval
completedbooleanWhether the action was completed immediately

Status Codes

Status CodeDescription
201Success - KYC group created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing authentication token
409Conflict - KYC group with the same name already exists
500Internal Server Error