Retrieve risk status
Returns the current risk status for the account, including whether the account is restricted and any outstanding tasks required to resolve risk or compliance issues.
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example for get/v1/risk/account_status
curl https://api.paypercut.io/v1/risk/account_status \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"status": "action_required",
"blocking": true,
"tasks": [
{
"id": "string",
"requirement_id": "string",
"kind": "document_upload",
"blocking": true,
"status": "action_required",
"title": "string",
"description": "string",
"banner_type": "string",
"body": {
"template": "string",
"template_pairs": {
"additionalProperty": "string"
}
},
"cta": {
"text": "string",
"type": "primary",
"can_act": true
},
"resolution_path": "account_update",
"remediation_link_params": {
"embedded_resolution_path": "string"
},
"requirements": [
{
"id": "string",
"field_name": "string",
"currently_due": true,
"eventually_due": true,
"past_due": true,
"pending_verification": true,
"alternatives": [
"string"
]
}
],
"error_messages": [
{
"code": "string",
"reason": "string",
"requirement": "string"
}
],
"affected_capabilities": [
{
"id": "string",
"status": "string",
"description": "string"
}
],
"agreement_bundle": {
"agreement_kind": "string",
"agreement_version": 1,
"locale": "string",
"documents": [
{
"key": "string",
"title": "string",
"description": "string",
"url": "string",
"mandatory": true,
"locale": "string",
"doc_type": "string"
}
]
}
}
]
}
