Get KYB Status (Internal)

Returns the current status of the KYB (Know Your Business) process for a merchant. Includes the current state, next recommended action, and payout availability. Requires admin API key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

merchantIdstringRequired

Merchant identifier

Query Parameters

countrystringRequired

Country code (ISO 3166-1 alpha-2)

currencystringRequired

Currency code (ISO 4217)

Response

KYB status retrieved successfully

statusmap from strings to any

Current status of the KYB process

messagestring or null

Human-readable message describing the current status

nextStepenum or null

Next action recommended in the KYB process

payoutActiveboolean or null

Indicates whether payout functionality is active for the merchant

payinActiveboolean or null

Indicates whether payin functionality is active for the merchant

1	import requests
2
3	url = "https://api-test.koywe.com/api/v1/internal/merchants/123/kyb"
4
5	querystring = {"country":"CL","currency":"CLP"}
6
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"status": {
3	"key": "value"
4	},
5	"message": "Terms accepted. Please submit KYB information to create customer.",
6	"nextStep": "generate_terms_of_service",
7	"payoutActive": true,
8	"payinActive": true
9	}

Get KYB Status (Internal)

Authentication

Path Parameters

Headers

Query Parameters

Response

Errors