BYbyaccrue
Banking

Create KYC Application

Creates a new KYC (Know Your Customer) application for a user with their personal information. This initiates the identity verification process required for banking features. The application will be processed through automated checks and may require additional document verification depending on the verification outcome.

post/api/v1/users/:userId/kyc/application

Request

Path parameters

userIdstring uuid required

The unique identifier for the user

Example:550e8400-e29b-41d4-a716-446655440000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Example request

{
  "data": {
    "attributes": {
      "ipAddress": "192.168.1.1",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "5551234567",
      "dateOfBirth": "1990-01-15",
      "email": "john.doe@example.com",
      "street": "123 Main Street",
      "street2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "postalCode": "10001"
    }
  }
}

Response

KYC application created successfully. The response includes the initial verification status, which may be Pending, Approved, Denied, or AwaitingDocuments depending on automated checks.

Example response

{
  "data": {
    "attributes": {
      "status": "Approved"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.