Skip to main content
GET
/
templates
/
{id}
Get template by ID
curl --request GET \
  --url https://api.anycheck.ai/templates/{id} \
  --header 'X-API-Key: <api-key>'
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "KTP Verification", "description": "Template for KTP document verification and data extraction", "custom_id": "<string>", "instruction": "<string>", "schema": { "name": { "type": "string", "required": true }, "nik": { "type": "string", "required": true }, "birth_date": { "type": "date", "required": true } }, "config": {}, "type": "CUSTOM", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }

Authorizations

​
X-API-Key
string
header
required

API key for service-to-service authentication

Path Parameters

​
id
string<uuid>
required

Resource UUID

Response

Template details

​
id
string<uuid>

Unique template identifier

​
name
string

Template name

Example:

"KTP Verification"

​
description
string

Template description

Example:

"Template for KTP document verification and data extraction"

​
custom_id
string | null

Custom identifier for the template

​
instruction
string | null

Special instructions for template processing

​
schema
object

Data extraction schema definition

Example:
{
  "name": { "type": "string", "required": true },
  "nik": { "type": "string", "required": true },
  "birth_date": { "type": "date", "required": true }
}
​
config
object

Template configuration settings

​
type
enum<string>

Template type - custom or prebuilt

Available options:
CUSTOM,
PREBUILT
Example:

"CUSTOM"

​
created_at
string<date-time>

Template creation timestamp

​
updated_at
string<date-time> | null

Last update timestamp