GET
/
document_types
/
{type-id}
/
configurations
/
{config-name}
/
{version}
Get configuration by version
curl --request GET \
  --url https://api.sensible.so/v0/document_types/{type-id}/configurations/{config-name}/{version} \
  --header 'Authorization: Bearer <token>'
{
  "name": "anyco_auto_insurance_quote",
  "created": "2023-11-07T05:31:56Z",
  "configuration": "\"{\\r\\n\\t\\\"fingerprint\\\": {\\r\\n\\t\\t\\\"tests\\\": [\\r\\n\\t\\t\\t\\\"anyco\\\",\\r\\n\\t\\t\\t\\\"quoted coverage changes\\\"\\r\\n\\t\\t]\\r\\n\\t},\\r\\n\\t\\\"preprocessors\\\": [{\\r\\n\\t\\t\\\"type\\\": \\\"pageRange\\\",\\r\\n\\t\\t\\\"startPage\\\": 0,\\r\\n\\t\\t\\\"endPage\\\": 2\\r\\n\\t}],\\r\\n\\t\\\"fields\\\": [{\\r\\n\\t\\t\\\"id\\\": \\\"_driver_name_raw\\\",\\r\\n\\t\\t\\\"anchor\\\": \\\"name of driver\\\",\\r\\n\\t\\t\\\"method\\\": {\\r\\n\\t\\t\\t\\\"id\\\": \\\"label\\\",\\r\\n\\t\\t\\t\\\"position\\\": \\\"below\\\"\\r\\n\\t\\t}\\r\\n\\t}],\\r\\n\\t\\\"computed_fields\\\": [{\\r\\n\\t\\t\\t\\\"id\\\": \\\"driver_name_last\\\",\\r\\n\\t\\t\\t\\\"method\\\": {\\r\\n\\t\\t\\t\\t\\\"id\\\": \\\"split\\\",\\r\\n\\t\\t\\t\\t\\\"source_id\\\": \\\"_driver_name_raw\\\",\\r\\n\\t\\t\\t\\t\\\"separator\\\": \\\", \\\",\\r\\n\\t\\t\\t\\t\\\"index\\\": 1\\r\\n\\t\\t\\t}\\r\\n\\t\\t}\\r\\n\\r\\n\\t]\\r\\n}\"\n",
  "version_id": "<string>",
  "versions": [
    {
      "version_id": "fdE0LO4d2GftiGvPyeYbgpstRWyLrEdm",
      "datetime": "2023-11-07T05:31:56Z",
      "environments": [
        "production",
        "development"
      ],
      "draft": false
    }
  ]
}

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"

​
config-name
string
required

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

Required string length: 3 - 128
​
version
string
required

Unique identifier for a configuration version.

Response

The identified configuration

​
name
string
required

Unique user-friendly name for a configuration

Example:

"anyco_auto_insurance_quote"

​
created
string<date-time>
required

ISO 8601 date-time.

​
configuration
string
required

Configuration returned as stringified JSON.

Example:

"\"{\\r\\n\\t\\\"fingerprint\\\": {\\r\\n\\t\\t\\\"tests\\\": [\\r\\n\\t\\t\\t\\\"anyco\\\",\\r\\n\\t\\t\\t\\\"quoted coverage changes\\\"\\r\\n\\t\\t]\\r\\n\\t},\\r\\n\\t\\\"preprocessors\\\": [{\\r\\n\\t\\t\\\"type\\\": \\\"pageRange\\\",\\r\\n\\t\\t\\\"startPage\\\": 0,\\r\\n\\t\\t\\\"endPage\\\": 2\\r\\n\\t}],\\r\\n\\t\\\"fields\\\": [{\\r\\n\\t\\t\\\"id\\\": \\\"_driver_name_raw\\\",\\r\\n\\t\\t\\\"anchor\\\": \\\"name of driver\\\",\\r\\n\\t\\t\\\"method\\\": {\\r\\n\\t\\t\\t\\\"id\\\": \\\"label\\\",\\r\\n\\t\\t\\t\\\"position\\\": \\\"below\\\"\\r\\n\\t\\t}\\r\\n\\t}],\\r\\n\\t\\\"computed_fields\\\": [{\\r\\n\\t\\t\\t\\\"id\\\": \\\"driver_name_last\\\",\\r\\n\\t\\t\\t\\\"method\\\": {\\r\\n\\t\\t\\t\\t\\\"id\\\": \\\"split\\\",\\r\\n\\t\\t\\t\\t\\\"source_id\\\": \\\"_driver_name_raw\\\",\\r\\n\\t\\t\\t\\t\\\"separator\\\": \\\", \\\",\\r\\n\\t\\t\\t\\t\\\"index\\\": 1\\r\\n\\t\\t\\t}\\r\\n\\t\\t}\\r\\n\\r\\n\\t]\\r\\n}\"\n"

​
version_id
string
required
​
versions
object[]
required