GET
/
document_types
/
{type-id}
/
goldens
/
{document-name}
Get reference document metadata
curl --request GET \
  --url https://api.sensible.so/v0/document_types/{type-id}/goldens/{document-name} \
  --header 'Authorization: Bearer <token>'
{
  "name": "best_scan_form_num_1234",
  "created": "2023-11-07T05:31:56Z",
  "configuration": "anyco_auto_insurance_quote",
  "error": "<string>",
  "upload_url": "<string>",
  "download_url": "<string>",
  "thumbnail_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value.

Path Parameters

​
type-id
string<uuid>
required

The unique document type identifier in v4 UUID format. Find IDs using the /document_types endpoint.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
document-name
string
required

Unique name for a document. Find it in the Sensible app or from the /document_types/{type-id}}/goldens endpoint.

Required string length: 3 - 128

Response

The identified reference document

​
name
string
required

Unique user-friendly name for a document

Example:

"best_scan_form_num_1234"

​
created
string<date-time>
required

ISO 8601 date-time.

​
configuration
string

User-friendly name of the configuration to associate to the reference document

Required string length: 3 - 128
Example:

"anyco_auto_insurance_quote"

​
error
string

Any errors that occurred processing the reference document

​
upload_url
string

If present, the URL to which a reference document can be PUT

​
download_url
string

If present, the URL to GET to retrieve the reference document

​
thumbnail_url
string

If present, the URL to GET to retrieve a thumbnail image of the first page of the reference document