Get Document - Pigeon

Request

Path Params

id

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Successful Response

Body

name

string

required

Document name

type

enum<string>

required

Item type document was submitted for

Allowed values:

FILEE_SIGNATUREQUESTION

id

string

required

creation_date

string <date-time>

required

Document creation timestamp

item_id

string

required

ID of Request Item document was submitted for

size

integer

optional

Document size in bytes

recipient_id

string

optional

ID of recipient who submitted document

completed

boolean

optional

Indicates whether a document has been completed. Only applies to documents where type: E_SIGNATURE.

Example

{
    "name": "string",
    "type": "FILE",
    "id": "string",
    "creation_date": "2019-08-24T14:15:22Z",
    "item_id": "string",
    "size": 0,
    "recipient_id": "string",
    "completed": true
}

🟠404Record Not Found

🟠422Parameter Error