Read a task

get

https://api.dottedsign.com/v1/sign_tasks/read

Read a task.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

For this action, you can obtain more details about the task, including:

Fields Information
Verify Information
Attachments Information
Review Information

For more details about the verification process, please see Verify Identity with OTP.

Allow authentication via Bearer Token or JWT Code.

When authenticating via the Code header, the JWT code must come from the code query parameter of the share_link returned by the Get the share link API, and the verify_token returned by the Consent to quick sign API is required.

JWT Code is only for non-member signers

If the signer has a DottedSign account, reading the task via a JWT code is rejected with the login_required (401_030) error, no matter how the quick sign setting is configured. The signer has to sign in and read the task with a Bearer Token, or open the share link in a browser and sign in there.

scope: sign_tasks.general.read
available user plans: all

Query Params

task_id

integer

required

Task ID.

uuid

string

Verify method UUID.

verify_data

string

OTP code.

identity_verify_token

string

Identity verify token.

account_protect_token

string

Account protect token.

verify_token

string

Verify token returned from the Consent to quick sign API. Required if authentication is via JWT Code.

Headers

Authorization

string

OAuth2 Bearer token.

Code

string

JWT code for quick sign authentication. Use it instead of the Authorization bearer token to read or sign a task on behalf of a signer who is not a DottedSign member.

The Get the share link API returns a share_link such as https://www.dottedsign.com/task?code=eyJhbGciOiJIUzUxMiJ9....

JWT code is the value of that URL's code query parameter; it is not returned as a separate field in the response.

Quick sign authentication is only available to signers who do not have a DottedSign account. If the signer is a registered DottedSign member, the request is rejected with the login_required (401_030) error and the signer must sign in to read and sign the task, no matter how the quick sign setting is configured.

Responses

200200

400400

401401

403403

406406