Welcome to Dapi

Here you will find comprehensive documentation to help you integrate with Dapi's API as quickly as possible, as well as support if you get stuck. Get started below!

Get Started    

Job Status

Use Job Status to check the status of any past job.

Jobs can have the following status responses:

  • done: a job is successfully completed.
    The requested data is returned in the request's response.

  • initialized: a job has been initialized and is currently in progress.
    This is only displayed when the sync parameter is set to false (asynchronous response), in which case connection is not maintained while the operation is in progress.
    The jobID can be used to retrieve the operation result once it is complete.

  • user_input_required: the bank requires further information from the user, such as an MFA (e.g. OTP, secret question, CAPTCHA).
    The job is temporarily halted until the user provides required information.

  • failed: request parameters (accessCode, accessToken, userSecret, appSecret, etc). are incorrect or expired (accessCode or accessToken). (For a full list of errors see Errors )

📘

Note

For more information, see Platform Overview.

Request

[POST] https://api.dapi.co/v1/job/status

Body Parameters

Parameter

Type

Description

appSecret
REQUIRED

String

Private token generated at application creation.

userSecret
OPTIONAL

String

Encrypted version of the userKey.

Note: If your client device is the one initiating the job status calls, then userSecret should be sent for additional authentication.

sync
REQUIRED

Boolean

Set to true so the connection is maintained until the job is complete (synchronous response).

jobID
REQUIRED

String

Unique ID generated to identify a specific operation.

Response

📘

Note

Your responses may differ from those listed below on a case-by-case basis.

Parameter

Type

Description

jobID

String

Unique ID generated to identify a specific operation.

success

Boolean

Returns true if request is successful and false for all else.

status

String

Returns the status of the job: done, initialized or user_input_required.

reference

String

A reference number for the transfer as provided by the financial institution.

Job Completed

{
    "jobID": "355b01ed-fb50-4bf0-b7f6-71b4cf94971c",
    "success": true,
    "status": "done",
    "reference": "12345678"
}

User Input Required

{
    "jobID": "47204fa6-dca6-44a5-8111-6c6489a232a2",
    "success": true,
    "status": "user_input_required",
    "userInputs": [
        {
            "id": "otp",
            "query": "Please enter the One Time Password sent to your registered mobile number"
        }
    ]
}

Error

{
    “success”: false,
    “msg”: “Invalid JSON request”,
    “type”: “INVALID_JSON”
}
{
    "success": false,
    "msg": "Invalid/expired token, invalid secret or invalid connectionID"
}

📘

Note

For more information and detailed breakdown of possible errors, please see Errors.

Updated 11 months ago


What's Next

Resume Job

Job Status


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.