CKYC Bulk Webhook Config Get

Endpoint Overview

GET /api/v1/ckyc/v1/bulk/webhook-config

Description

Returns the current account-level CKYC bulk webhook URL configured for the authenticated account. This config is shared across individual and legal-entity bulk flows.

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Environment URLs:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer JWT token (`Bearer <JWT>`)

Request Query / Body

This endpoint does not require a request body. The account email is derived from the authenticated user context.

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Response payload
data.webhook_url	String \| Null	Currently configured webhook URL for the account
status_code	Integer	HTTP status code
success	Boolean	Whether the request was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

Example Successful Response

{
    "data": {
        "webhook_url": "https://hooks.example.com/ckyc-bulk"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Example Response When Not Configured

{
    "data": {
        "webhook_url": null
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Authentication Failed

Account Not Found

{
    "data": null,
    "status_code": 401,
    "success": false,
    "message": "Unauthorized",
    "message_code": "auth_failed"
}

The JWT token is missing, expired, or invalid.

Heads Up

Account-level config -- The returned webhook_url applies to both individual and legal CKYC bulk batches under the same account.

No delivery payload here -- This endpoint only returns config. Webhook event payload details are documented in CKYC Bulk Webhook Config Create.

Code Samples

cURL

Python

Node.js

Related Steps

CKYC Bulk Webhook Config Create -- Create the webhook URL for the account

CKYC Bulk Webhook Config Delete -- Remove the configured webhook URL

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

CKYC Bulk Webhook Config Get

CKYC Bulk Webhook Config Get#

Description#

Technical Implementation#

Request Headers#

Request Query / Body#

Response Parameters#

Example Successful Response#

Example Response When Not Configured#

Possible Error Responses#

Code Samples#

Request

Responses

CKYC Bulk Webhook Config Get

Description

Technical Implementation

Request Headers

Request Query / Body

Response Parameters

Example Successful Response

Example Response When Not Configured

Possible Error Responses

Code Samples