Tasks

Tasks are retrieved through the account compliance status endpoint.

This endpoint provides a consolidated view of:

• whether the account is blocked
• what actions are required
• which tasks must be completed

Retrieve account status

GET /v1/risk/account_status

Example response

{
  "account_id": "01KN7T8K7WRF9C8MF1CA4KPM6Z",
  "blocking": true,
  "status": "action_required",
  "tasks": [
    {
      "id": "task_01KN7T9RTDYQ7GR5PW1Q9H2E5M",
      "kind": "agreement_bundle",
      "status": "action_required",
      "blocking": true,
      "requirement_id": "01KN7T9RTDYQ7GR5PW1Q9H2E5M",
      "agreement_bundle": {
        "agreement_kind": "three_party_agreement",
        "agreement_version": 1,
        "locale": "en",
        "documents": [
          {
            "key": "three_party_agreement_v1",
            "title": "Tri-Party Merchant Agreement",
            "mandatory": true,
            "url": "https://dashboard.paypercut.io/files/..."
          }
        ]
      }
    }
  ]
}

Response fields

account_id

Identifier of the connected account.

blocking

Indicates whether the account is currently blocked due to incomplete tasks.

status

High-level account compliance status.

Typical values include:

• ok
• action_required

Tasks array

Each task represents a required action.

id

Unique identifier of the task.

kind

Type of task.

Example:

• agreement_bundle

status

Current state of the task.

Example:

• action_required
• completed

blocking

Indicates whether the task prevents the account from operating.

requirement_id

Reference to the underlying requirement that produced the task.

Agreement bundle tasks

Agreement bundle tasks provide structured data for collecting agreement acceptance.

They include:

• Agreement metadata
• Document list
• Mandatory flags
• URLs for each document

No tasks

If no tasks are returned:

{
  "account_id": "01KN7T8K7WRF9C8MF1CA4KPM6Z",
  "blocking": false,
  "status": "ok"
}

The account has no outstanding compliance actions.

Recommended integration pattern

• Poll or fetch account status when loading onboarding or account views
• Render tasks dynamically based on the response
• Do not hardcode task types or document structures