KYC
Start a business verification (KYB) session for one of your business customers
Creates a KYB session scoped to your project. The workflow is resolved from the request, then the organization's configured default KYB workflow, then the platform default. Results arrive at your configured KYC webhook as `kyb.completed`.
POST
/api/projects/{projectId}/kyb/sessionsSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, KYCApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const kyc = new KYCApi(configuration);import { Configuration, KYCApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const kyc = new KYCApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await kyc.request(
"proj_D1UJJChD4EiR",
{
workflowId: "jsYt7uzZ4TazisRM",
vendorBusinessId: "5v8JeKuGR6vrRDCS",
vendorData: "card navigate",
callback: "driver override",
language: "en-US"
}
);const { data: result } = await kyc.request(
"proj_D1UJJChD4EiR",
{
workflowId: "jsYt7uzZ4TazisRM",
vendorBusinessId: "5v8JeKuGR6vrRDCS",
vendorData: "card navigate",
callback: "driver override",
language: "en-US"
}
);Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | — |
Request Body
json
{
"workflowId": "3ZrBDUs8xH3irisK",
"vendorBusinessId": "f4WoHaygwiyRdDv7",
"vendorData": "application back up",
"callback": "feed synthesize",
"language": "en-US"
}{
"workflowId": "3ZrBDUs8xH3irisK",
"vendorBusinessId": "f4WoHaygwiyRdDv7",
"vendorData": "application back up",
"callback": "feed synthesize",
"language": "en-US"
}Responses
201KYB session created (returns the hosted verification URL)
400No KYB workflow configured, or invalid input
401Authentication required
503KYC is not configured on this server
Errors
| Code | Meaning |
|---|---|
400 | No KYB workflow configured, or invalid input |
401 | Authentication required |
503 | KYC is not configured on this server |