Get KYC Status

Retrieves the current KYC verification status for a user. Returns null if no KYC application has been submitted for the user. Use this endpoint to check the progress of a user's identity verification.

get/api/v1/users/:userId/kyc/status

Request

Base URL
https://merchant-api.accruesavings.com
Auth
none declared. Required headers: Client-ID, Authorization
TypeScript
https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/users/:userId/kyc/status/get.ts
A function with typed inputs. Its response is checked against the schema.

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

Response

KYC status retrieved successfully. Returns the current verification status or null if no application exists.

Example response

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

Changes

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