GET /v1/signature/envelopes/{id}/requested-documents

GET

/v1/signature/envelopes/{id}/requested-documents

curl --request GET \
  --url https://api.asap.cool/v1/signature/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/requested-documents \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key
  signature:read
• session

Parameters

Path Parameters

id

required

string format: uuid

Envelope identifier.

Responses

200

The envelope’s requested documents.

Media type application/json

Array<object>

Public projection of a [RequestedDocument].

object

id

required

Stable identifier.

string format: uuid

label

required

Human label shown to the signer.

string

position

required

Display order.

integer format: int32

required

required

Whether the upload blocks signing.

boolean

signer_id

The signer it is requested from; null = any signer.

string | null format: uuid

Example ^generated

[
  {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "label": "example",
    "position": 1,
    "required": true,
    "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing signature:read scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

404

Not found or cross-org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}