Skip to main content
GET
/
partner
/
v1
/
kyc
/
status
Get current KYC status
curl --request GET \
  --url https://api.machines.cash/partner/v1/kyc/status \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "data": {
    "status": "not_submitted",
    "isTermsOfServiceAccepted": true,
    "reason": "<string>",
    "completionLink": "<string>",
    "externalVerificationLink": "<string>",
    "isActive": true
  },
  "summary": "<string>",
  "errors": [
    {
      "code": "invalid_request",
      "message": "missing required field",
      "field": "<string>"
    }
  ],
  "next": {
    "pollAfterMs": 1,
    "suggestedTool": "<string>",
    "suggestedArgs": {}
  }
}

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 status

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