getUserTask

The getUserTask API retrieves pending tasks and setup requirements for a specific user.

What it does:

• Returns pending tasks with descriptions for user onboarding and setup
• Provides actionable task information to guide completion of user requirements

Notes:

• Used to track individual user onboarding progress and identify incomplete steps
• Incomplete steps (verification and missing direct deposit account) prevent an employee from moving on from the onboarding process

GET /reports#getUserTask

getUserTask

cURL

curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getUserTask' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getUserTask",
  "userId": "D32D7451-FE6C-44D3-8DDB-E6442A15884E"
}
'

200

1

{
  "task": [
    {
      "type": "KYC Verification",
      "description": "Your KYC status is pending. Please wait for the process to complete or contact support for more information."
    },
    {
      "type": "Link Direct Deposit Account",
      "description": "Connect your direct deposit account"
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

userId · string · required

Response

200

application/json

task · object[] · required

Show child attributes