Skip to main content
GET
/
partner
/
v1
/
kyc
/
values
Get KYC field requirements and values
curl --request GET \
  --url https://api.machines.cash/partner/v1/kyc/values \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "data": {
    "fields": [
      {
        "name": "<string>",
        "required": true,
        "type": "<string>",
        "maxLength": 123,
        "minLength": 123,
        "regex": "<string>",
        "enum": [
          "<string>"
        ],
        "description": "<string>"
      }
    ],
    "occupations": [
      {
        "code": "<string>",
        "label": "<string>"
      }
    ],
    "annualSalary": [
      "<string>"
    ],
    "expectedMonthlyVolume": [
      "<string>"
    ],
    "accountPurpose": [
      "<string>"
    ]
  },
  "summary": "<string>",
  "errors": [
    {
      "code": "invalid_request",
      "message": "missing required field",
      "field": "<string>"
    }
  ],
  "next": {
    "pollAfterMs": 1,
    "suggestedTool": "<string>",
    "suggestedArgs": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.machines.cash/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Open-Responses
enum<string>

Return Open Responses-compatible output when set (replaces the default response envelope).

Available options:
1,
true
​
X-Open-Responses-Call-Id
string

Tool call id used for function_call_output items when Open Responses mode is enabled.

Minimum string length: 1

Response

KYC values

​
ok
boolean
required
​
data
object
required
​
summary
string
required
​
errors
object[]
required
​
next
object