OCR KTP Check

curl --request POST \
  --url https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form request_id=c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f \
  --form image='@example-file'

import requests

url = "https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify"

files = { "image": ("example-file", open("example-file", "rb")) }
payload = { "request_id": "c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('request_id', 'c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f');
form.append('image', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "request_id": "c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "id_number": "3175012345670001",
    "name": "Budi Santoso",
    "blood_type": "O",
    "religion": "ISLAM",
    "gender": "LAKI-LAKI",
    "birth_place_birthday": "JAKARTA, 17-08-1990",
    "province": "DKI JAKARTA",
    "city": "JAKARTA SELATAN",
    "district": "KEBAYORAN BARU",
    "village": "GUNUNG",
    "rtrw": "003/004",
    "occupation": "KARYAWAN SWASTA",
    "expiry_date": "SEUMUR HIDUP",
    "nationality": "WNI",
    "marital_status": "KAWIN",
    "address": "JL. SENOPATI RAYA NO. 10",
    "place_of_birth": "JAKARTA",
    "birthday": "17-08-1990",
    "issue_date": "12-03-2019",
    "place_of_issue": "JAKARTA SELATAN"
  },
  "request_id": "c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
  "pricing": "PAID"
}

OCR

OCR KTP Check

Reads the fields printed on an Indonesian KTP (ID card) from an uploaded photo. A completed extraction is billed (pricing=PAID). Validation failures, an image the OCR engine cannot read as an ID card, and service failures are not billed (pricing=FREE).

This feature must be enabled on your account. If it is not, the API returns UNAUTHORIZED.

Outcomes

Result	Response
Extraction succeeded	`code=SUCCESS`, `pricing=PAID`
Image isn’t a recognizable ID card (per the OCR engine)	`code=CLIENT_ERROR`, `pricing=FREE`
Extracted `id_number` isn’t a valid 16-digit NIK	`code=CLIENT_ERROR`, `pricing=FREE`
Missing `request_id` / `image`, or wrong image format	`code=CLIENT_ERROR`, `pricing=FREE` (HTTP 400)
Image exceeds 8MB	`code=CLIENT_ERROR`, `pricing=FREE` (HTTP 413)
Temporary service issue	`code=SERVER_ERROR`, `pricing=FREE`
Same `request_id` reused after a completed extraction	`code=DUPLICATE_REFERENCE`, `pricing=FREE` (HTTP 409) — always, regardless of what image you send this time
Same `request_id` reused after a failed attempt	Retried for real: the image you send this time is what actually gets processed and (if it succeeds) billed
Missing token, feature not enabled, or IP not allowlisted	`code=UNAUTHORIZED`, `pricing=FREE`
Prepaid balance too low	`code=INSUFFICIENT_BALANCE`, `pricing=FREE`

Image requirements

JPEG or PNG only (checked against the actual bytes, not just the declared Content-Type), 8MB maximum.

Idempotency

Use a unique request_id for each new extraction (UUID v4 is recommended). Reusing a request_id that already resolved to a completed extraction always returns DUPLICATE_REFERENCE, regardless of what image you send this time — mint a new request_id for every extraction attempt. Reusing a request_id whose prior attempt failed retries for real — the image you send this time is what actually gets processed and (if it succeeds) billed.

POST

api

kyc

ocr-ktp-verify

OCR KTP Check

curl --request POST \
  --url https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form request_id=c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f \
  --form image='@example-file'

import requests

url = "https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify"

files = { "image": ("example-file", open("example-file", "rb")) }
payload = { "request_id": "c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('request_id', 'c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f');
form.append('image', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-apigw.singapay.id/api/v1/kyc/ocr-ktp-verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"request_id\"\r\n\r\nc3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "code": "SUCCESS",
  "message": "OK",
  "data": {
    "request_id": "c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "id_number": "3175012345670001",
    "name": "Budi Santoso",
    "blood_type": "O",
    "religion": "ISLAM",
    "gender": "LAKI-LAKI",
    "birth_place_birthday": "JAKARTA, 17-08-1990",
    "province": "DKI JAKARTA",
    "city": "JAKARTA SELATAN",
    "district": "KEBAYORAN BARU",
    "village": "GUNUNG",
    "rtrw": "003/004",
    "occupation": "KARYAWAN SWASTA",
    "expiry_date": "SEUMUR HIDUP",
    "nationality": "WNI",
    "marital_status": "KAWIN",
    "address": "JL. SENOPATI RAYA NO. 10",
    "place_of_birth": "JAKARTA",
    "birthday": "17-08-1990",
    "issue_date": "12-03-2019",
    "place_of_issue": "JAKARTA SELATAN"
  },
  "request_id": "c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
  "pricing": "PAID"
}

Authorizations

Authorization

string

header

required

Access token from POST /api/v1/kyc/auth/get-auth-token. Valid for one hour.

Body

multipart/form-data

request_id

string

required

Your unique reference for this extraction. Use a new UUID for each new attempt.

Example:

"c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f"

image

file

required

Photo of the KTP. JPEG or PNG only, 8MB maximum.

Response

Extraction complete. code is SUCCESS. data holds the extracted fields. pricing is PAID.

code

enum<string>

required

Always SUCCESS on this response.

Available options:

SUCCESS

Example:

"SUCCESS"

message

enum<string>

required

Always OK. Use code and data, not this field, to branch.

Available options:

OK

Example:

"OK"

data

object

required

Extracted KTP fields. Every value is a plain string, printed on the card verbatim (uppercase, Indonesian). A field the OCR engine could not read comes back as "", never omitted or null — this is not a matching verdict like e-wallet/bank's VerifyData, so there is no status / similarity / suggestion here.

Show child attributes

request_id

string

required

The request_id you sent.

Example:

"c3d4e5f6-1a2b-3c4d-5e6f-7a8b9c0d1e2f"

pricing

enum<string>

required

Always PAID on this response.

Available options:

PAID

Example:

"PAID"