API Endpoint Reference

Get Document

get
https://api.proof.com/v1/transactions//documents/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns

Returns a base64-encoded version of a document object attached to a transaction. The document state will be reflected by the status of the transaction.

Path Params
string
required

ID of the transaction to get the document from.

string
required

The ID of the document to be retrieved.

Query Params
string
enum
Defaults to v1

Control documents and signer photo identifications download URLs. v1 for AWS S3 pre-signed URLs. v2 for Proof secure URLs.

Allowed:
string

Can be either "base64" or "uri". Using "uri" will return a hosted url for the document only after the transaction has been completed.

Responses

Updated 11 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago