Get KYC field requirements
curl --request GET \
--url https://api.machines.cash/partner/v1/kyc/schema \
--header 'X-Partner-Key: <api-key>'const options = {method: 'GET', headers: {'X-Partner-Key': '<api-key>'}};
fetch('https://api.machines.cash/partner/v1/kyc/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.machines.cash/partner/v1/kyc/schema"
headers = {"X-Partner-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"data": {
"fields": [
{
"name": "<string>",
"required": true,
"type": "<string>",
"maxLength": 123,
"minLength": 123,
"regex": "<string>",
"enum": [
"<string>"
],
"description": "<string>"
}
]
},
"summary": "<string>",
"errors": [
{
"code": "invalid_request",
"message": "missing required field",
"field": "<string>"
}
],
"next": {
"pollAfterMs": 1,
"suggestedTool": "<string>",
"suggestedArgs": {}
}
}{
"ok": false,
"summary": "invalid request",
"errors": [
{
"code": "invalid_request",
"message": "missing required field",
"field": "<string>"
}
],
"next": {
"pollAfterMs": 1,
"suggestedTool": "<string>",
"suggestedArgs": {}
}
}{
"ok": false,
"summary": "invalid request",
"errors": [
{
"code": "invalid_request",
"message": "missing required field",
"field": "<string>"
}
],
"next": {
"pollAfterMs": 1,
"suggestedTool": "<string>",
"suggestedArgs": {}
}
}KYC API
Get KYC field requirements
GET
/
partner
/
v1
/
kyc
/
schema
Get KYC field requirements
curl --request GET \
--url https://api.machines.cash/partner/v1/kyc/schema \
--header 'X-Partner-Key: <api-key>'const options = {method: 'GET', headers: {'X-Partner-Key': '<api-key>'}};
fetch('https://api.machines.cash/partner/v1/kyc/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.machines.cash/partner/v1/kyc/schema"
headers = {"X-Partner-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"data": {
"fields": [
{
"name": "<string>",
"required": true,
"type": "<string>",
"maxLength": 123,
"minLength": 123,
"regex": "<string>",
"enum": [
"<string>"
],
"description": "<string>"
}
]
},
"summary": "<string>",
"errors": [
{
"code": "invalid_request",
"message": "missing required field",
"field": "<string>"
}
],
"next": {
"pollAfterMs": 1,
"suggestedTool": "<string>",
"suggestedArgs": {}
}
}{
"ok": false,
"summary": "invalid request",
"errors": [
{
"code": "invalid_request",
"message": "missing required field",
"field": "<string>"
}
],
"next": {
"pollAfterMs": 1,
"suggestedTool": "<string>",
"suggestedArgs": {}
}
}{
"ok": false,
"summary": "invalid request",
"errors": [
{
"code": "invalid_request",
"message": "missing required field",
"field": "<string>"
}
],
"next": {
"pollAfterMs": 1,
"suggestedTool": "<string>",
"suggestedArgs": {}
}
}Authorizations
Headers
Return Open Responses-compatible output when set (replaces the default response envelope).
Available options:
1, true Tool call id used for function_call_output items when Open Responses mode is enabled.
Minimum string length:
1⌘I