> For the complete documentation index, see [llms.txt](https://docs.vida.id/identity-stack/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vida.id/identity-stack/verify/document-ai/ocr-and-document-verification/ocr-ktp/api-reference.md).

# API Reference

The VIDA Identity OCR API provides the following set of APIs to extract information from a user's KTP card image using OCR.

### Authentication

In order to make API requests, partners need to include an "authorisation header" in each request they make. This header should contain a unique "bearer access token", which serves as a form of authentication.

### KTP OCR API - Async Call:

This API performs KTP OCR asynchronously. You need to provide the KTP card image as a Base64 encoded data URI in the request body. It returns a transaction ID that can be used to check the status later.

### Get Transaction Status API:

This API allows you to retrieve the details and status of a specific OCR API request. You need to provide the transaction ID obtained from the initial OCR request. The response will indicate whether the verification is still in progress or if it has been completed successfully.

### KTP OCR API - Sync Call:

This API performs KTP OCR synchronously. You provide the KTP card image as a Base64 encoded string in the request body, and the API directly returns the extracted data in the response. There is no need for a separate transaction status check.

The extracted data from the KTP card includes information such as the person's name, address, date of birth, marital status, and more. The API response also includes a transaction ID that can be used for tracking and reference purposes.