---
title: "Extract SIM"
method: POST
path: "/ocr/sim"
tags: ["SIM"]
---

# Extract SIM

`POST /ocr/sim`

## Request

- Base URL: `https://api.verihubs.com`
- URL: `https://api.verihubs.com/ocr/sim`
- Auth: none declared. Required headers: `App-ID`, `API-Key`

The purpose of OCR is to extract information from SIM image. The result will be in “text” format. All the data inside SIM will be extracted.

  You will receive a response consists of message and an error code if the
request fails to process. The following is a list of error codes.
<br>

| Error status                                  | Error code                    | Description                                  |
| ------------------------------|----------------------------------------------|----------------------------------------------|
| 200 | SIM_NOT_DETECTED  | Image is not detected as SIM |
| 400 | INVALID_PAYLOAD                | No value in payload   |
| 400 | INVALID_PAYLOAD_IMAGE_FORMAT        |  Invalid  image format                      |
| 400 | INSUFFICIENT_QUOTA         |  Quota is not sufficient to continue                       |
| 500 | INTERNAL_SERVER_ERROR         | Internal server error |

## Headers

- `App-ID` string, required
- `API-Key` string, required

## Request body `multipart/form-data`

- ExtractSIM
  - `image` string, binary, required: SIM image file

## Response `200`

Successful Response

- ResponseExtractSIM
  - `Message` string: Message indicating the status of the request to be processed
  - `data` object: Show the recognition result
    - `sim_number` string: Shows SIM number
    - `sim_type` string: Shows type of SIM
    - `name` string: Shows name from SIM
    - `address` string: Shows address from SIM
    - `occupation` string: Shows occupation from SIM
    - `gender` string: Shows gender from SIM
    - `domain` string: Shows domain of SIM
    - `blood_type` string: Shows blood type from SIM
    - `birth_date` string: Shows birth date from SIM
    - `birth_place` string: Shows birth place from SIM
    - `height` string: Shows height from SIM
    - `valid_until` string: Shows expiry date of SIM

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/verihubs/apis/ai-api-documentation.md) - [All operations](https://skmtc.dev/verihubs/apis/ai-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/verihubs/apis/ai-api-documentation/revisions/9313db607e15?raw)