AI Service > OCR > Document OCR > API v1.0 Guide

Document OCR API Common Information

API Endpoints

Authentication and Authorization

AppKey and SecretKey are required to use the Document OCR API. An Appkey is a unique authentication key issued for each NHN Cloud service, used to identify the service and validate API requests. A SecretKey is a private key used to control access to the API. For more information on checking and using Appkeys and SecretKeys, please refer to the Appkey.

Project Integrated Appkey can be used in place of the Appkey. Project Integrated Appkey is a common authentication key that can be shared across multiple services within a single NHN Cloud project. For more information on creating and using Project Integrated Appkeys, please refer to the Project Integrated Appkey.

Common Response Information

All API requests return HTTP 200 OK. The success or failure of an API request can be determined by referring to the header in the Response Body.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "header": {
        "resultCode": 0,
        "resultMessage": "SUCCESS",
        "isSuccessful": true
    },
    "result": {
        ...
    }
}

{
    "header": {
        "isSuccessful": false,
        "resultCode": -1,
        "resultMessage": "Unknown error."
    }
}

Error Codes

Common

Business Registration Certificate Analysis API

Request

[URI]

[Request Header]

[Path Variable]

[Request Body]

• Put the binary data of the image file.

curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/business' \
-F 'image=@sample.png' \
-H 'Authorization: ${secretKey}'

[Field]

Response

[Response Body]

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "result": {
    "fileType": "png",
    "unitType": "pixel",
    "keyValues": [
      {
        "key":"구분",
        "value":" 간이과세자",
        "conf":0.93
      },
      {
        "key":"등록번호",
        "value":"123-45-67890",
        "conf":1
      },
      ...
    ],
    "boxes": [
      {
        "x1": 340,
        "y1": 3231,
        "x2": 523,
        "y2": 3231,
        "x3": 523,
        "y3": 3297,
        "x4": 340,
        "y4": 3297
      },
      ...
    ],
    "resolution": "normal"
  }
}

[Header]

[Field]

• boxes[0]

Retrieve Business Registration Stoppage/Closure API

Request

[URI]

[Request Header]

[Path Variable]

[Field]

[Request Body]

curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/business/status' \
-H 'Authorization: ${secretKey}' \
--data-raw '{
  "businessNumber": "1234567890"
}'

Response

[Response Body]

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "result": {
    "statusCode": "00",
    "statusMessage": ""
  }
}

[Header]

[Field]

• List of Business Registration Certificate Statuses by "statusCode"

Credit Card Analysis API

Request

[URI]

[Request Header]

[Path Variable]

[Request Body]

• Put the binary data of the image file.

curl -X POST 'https://ocr.api.nhncloudservice.com/v1.0/appkeys/{appKey}/credit-card' \
-F 'image=@sample.png' \
-H 'Authorization: ${secretKey}'

[Field]

Response

[Response Body]

{
  "header": {
    "isSuccessful": true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "result": {
    "fileType": "png",
    "resolution": "low",
    "cardNums": [
      {
        "value": "1111",
        "conf": 0.87
      },
      {
        "value": "2222",
        "conf": 0.99
      },
      {
        "value": "3333",
        "conf": 0.97
      },
      {
        "value": "4444",
        "conf": 0.89
      }
    ],
    "totalCardNum": "111222233334444",
    "cardNumBoxes": [
      {
        "x1": 62,
        "y1": 256,
        "x2": 192,
        "y2": 256,
        "x3": 192,
        "y3": 301,
        "x4": 62,
        "y4": 301
      },
      ...
    ],
    "validThru": {
      "value": "04/19",
      "conf": 0.53
    },
    "validThruBox": {
      "x1": 316,
      "y1": 315,
      "x2": 426,
      "y2": 315,
      "x3": 426,
      "y3": 347,
      "x4": 316,
      "y4": 347
    }
  }
}

[Header]

[Field]

• boxes[0]