事業者登録証

印刷する
共有
PDF

事業者登録証

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

特化モデルエンジンを使用して事業者登録証の入力情報(key-value)を認識し、抽出します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/biz-license

リクエストヘッダ

CLOVA OCR APIで共通して使用されるヘッダの詳細は、CLOVA OCRのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

`Content-Type: application/json`の場合

リクエストヘッダのContent-Typeがapplication/jsonの場合のリクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`version`	String	-	バージョン情報 `V2`のみ使用
`requestId`	String	Required	任意の API呼び出しの UUID
`timestamp`	Integer	Required	任意の APIの呼び出し時刻(Timestamp)
`images`	Array	Required	imagesの詳細情報

`Content-Type: multipart/form-data`の場合

リクエストヘッダのContent-Typeがmultipart/form-dataの場合のリクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`message`	Object	Required	リクエストデータ情報
`message.version`	String	Required	バージョン情報 `V2`のみ使用
`message.requestId`	String	Required	任意の API呼び出しの UUID
`message.timestamp`	Integer	Required	任意の APIの呼び出し時刻(Timestamp)
`message.images`	Array	Required	imagesの詳細情報
`file`	File	Required	OCR認識画像ファイル

`images`

imagesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`format`	String	Required	画像の形式 `jpg` \| `jpeg` \| `png` \| `pdf` \| `tif` \| `tiff` 画像: `jpg`、`jpeg`、`png` 単一ページ: `pdf`、`tif`、`tiff` 画像の形式のうち、1つを選択して入力
`name`	String	Required	任意の画像名画像の識別とレスポンス結果の確認時に使用
`data`	String	Required	Base64でエンコードされた画像データ `Content-Type: application/json`の場合に入力可能

リクエスト例

リクエストのサンプルコードは次の通りです。

`Content-Type: application/json`の場合

リクエストヘッダのContent-Typeがapplication/jsonの場合のリクエストのサンプルコードは次の通りです。

curl --location 'https://cbgrx5natw.apigw.ntruss.com/custom/v1/{DomainId}/{InvokeKey}/document/biz-license' \
--header 'Content-Type: application/json' \
--header 'X-OCR-SECRET: {アプリの登録時に発行された Secret Key}' \
--data '{
    "version": "V2",
    "requestId": "string",
    "timestamp": 0,
    "images": [
        {
            "format": "jpg",
            "name": "bizlicense_test",
            "data": "{Base64でエンコードされた画像データ}"
        }
    ]
 }'

`Content-Type: multipart/form-data`の場合

リクエストヘッダのContent-Typeがmultipart/form-dataの場合のリクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://cbgrx5natw.apigw.ntruss.com/custom/v1/{DomainId}/{InvokeKey}/document/biz-license' \
--header 'X-OCR-SECRET: {アプリの登録時に発行された Secret Key}' \
--header 'Content-Type: multipart/form-data' \
--form 'message="{\"version\": \"V2\", \"requestId\": \"1234\", \"timestamp\": 1724832750462, \"images\": [{\"format\": \"pdf\", \"name\": \"bizlicense_test\"}]}"' \
--form 'file=@"{file}"'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`version`	String	-	バージョン情報 `V2`のみ使用
`requestId`	String	-	API呼び出し UUID
`timestamp`	Integer	-	APIの呼び出し時刻(Timestamp)
`images`	Array	-	imagesの詳細情報

`images`

imagesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`uid`	String	-	事業者登録証画像の UID API有効性検査時に使用
`name`	String	-	事業者登録証の画像名画像の識別とレスポンス結果の確認時に使用
`inferResult`	String	-	事業者登録証の画像認識結果 `SUCCESS` \| `FAILURE` \| `ERROR` `SUCCESS`: 認識成功 `FAILURE`: 認識失敗 `ERROR`: 認識処理例外
`message`	String	-	結果メッセージ
`validationResult`	Object	-	有効性検査の結果情報
`validationResult.result`	String	-	有効性検査の結果コード `NO_REQUESTED` \| `UNCHECKED` \| `ERROR` \| `VALID` \| `INVALID` `NO_REQUESTED`: 検証をリクエストしていない(有効性検査失敗) `UNCHECKED`: 検証の有無を確認できない `ERROR`: 検証中にエラー発生(有効性検査失敗) `VALID`: 検証中にエラー発生(有効性検査成功) `INVALID`: 検証合格失敗
`validationResult.message`	String	-	有効性検査結果の詳細メッセージ必ずしも返される値ではない
`convertedImageInfo`	Object	-	変換後の画像情報 `format`が`pdf`または`tiff`の場合座標は呼び出し画像ファイルを基準に設定
`convertedImageInfo.width`	Integer	-	変換後画像の横長
`convertedImageInfo.height`	Integer	-	変換後画像の縦長
`convertedImageInfo.pageIndex`	Integer	-	変換後画像ページインデックス
`bizLicense`	Object	-	事業者登録証の詳細情報
`bizLicense.meta`	Object	-	メタ情報
`bizLicense.meta.estimatedLanguage`	String	-	OCR推定言語 `ko` \| `en` \| `ja` `ko`:韓国語 `en`: 英語 `ja`: 日本語
`bizLicense.result`	Object	-	事業者登録証の OCR認識結果

`result`

resultの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`bisAddress`	Array	-	事業場の住所情報共通オブジェクト情報を参照
`bisArea`	Array	-	事業場の所在地情報共通オブジェクト情報を参照
`bisItem`	Array	-	事業項目情報共通オブジェクト情報を参照
`registerNumber`	Array	-	事業者登録番号情報共通オブジェクト情報を参照
`bisType`	Array	-	業種情報共通オブジェクト情報を参照
`companyName`	Array	-	企業名共通オブジェクト情報を参照
`corpName`	Array	-	法人(企業)名共通オブジェクト情報を参照
`corpRegisterNum`	Array	-	法人(企業)の事業者登録番号共通オブジェクト情報を参照
`coRepSocialNum`	Array	-	共同代表者の住民登録番号共通オブジェクト情報を参照
`documentType`	Array	-	文書タイプのオブジェクト情報
`headAddress`	Array	-	本社の住所情報共通オブジェクト情報を参照
`issuanceDate`	Array	-	発行日情報共通オブジェクト情報を参照
`issuanceReason`	Array	-	発行理由情報共通オブジェクト情報を参照
`openDate`	Array	-	事業開始日情報共通オブジェクト情報を参照
`repName`	Array	-	代表者名情報共通オブジェクト情報を参照
`socialNumber`	Array	-	住民登録番号情報共通オブジェクト情報を参照
`taxType`	Array	-	課税タイプ情報共通オブジェクト情報を参照

共通オブジェクト情報

共通オブジェクト情報の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`text`	String	-	認識結果のテキスト
`keyText`	String	-	認識結果のテキストのキー
`confidenceScore`	Float	-	認識結果のテキストの信頼度 0~1 信頼度が高いほどテキストの精度が高い
`boundingPolys`	Array	-	boundingPolyの詳細情報

文書タイプのオブジェクト情報

文書タイプのオブジェクト情報の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`text`	String	-	認識結果のテキスト
`formatted`	Object	-	認識結果のテキスト情報
`formatted.value`	String	-	認識結果のテキストの値
`keyText`	String	-	認識結果のテキストのキー
`confidenceScore`	Float	-	認識結果のテキストの信頼度 0~1 信頼度が高いほどテキストの精度が高い
`boundingPolys`	Array	-	boundingPolyの詳細情報
`maskingPolys`	Array	-	maskingPolyの詳細情報

`boundingPolys`

boundingPolysの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`vertices`	Array	-	verticesの詳細情報

`maskingPolys`

maskingPolysの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`vertices`	Array	-	verticesの詳細情報

`boundingPolyvertices`

boundingPolyVerticesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`x`	Float	-	X軸の座標
`y`	Float	-	Y軸の座標

レスポンスステータスコード

CLOVA OCR APIで共通して使用されるレスポンスステータスコードの詳細は、CLOVA OCRの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

成功

呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

{
    "version": "V2",
    "requestId": "1234",
    "timestamp": 1725247772348,
    "images": [
        {
            "uid": "{uid}",
            "name": "bizlicense_test",
            "inferResult": "SUCCESS",
            "message": "SUCCESS",
            "validationResult": {
                "result": "NO_REQUESTED"
            },
            "bizLicense": {
                "meta": {
                    "estimatedLanguage": "ko"
                },
                "result": {
                    "bisAddress": [
                        {
                            "text": "ソウル特別市***",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 371.0,
                                            "y": 547.0
                                        },
                                        {
                                            "x": 479.0,
                                            "y": 550.0
                                        },
                                        {
                                            "x": 479.0,
                                            "y": 569.0
                                        },
                                        {
                                            "x": 371.0,
                                            "y": 567.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "bisItem": [
                        {
                            "text": "***",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 760.0,
                                            "y": 695.0
                                        },
                                        {
                                            "x": 783.0,
                                            "y": 695.0
                                        },
                                        {
                                            "x": 783.0,
                                            "y": 716.0
                                        },
                                        {
                                            "x": 760.0,
                                            "y": 716.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "registerNumber": [
                        {
                            "text": "***-**-*****",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 585.0,
                                            "y": 338.0
                                        },
                                        {
                                            "x": 636.0,
                                            "y": 338.0
                                        },
                                        {
                                            "x": 636.0,
                                            "y": 370.0
                                        },
                                        {
                                            "x": 585.0,
                                            "y": 370.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "bisType": [
                        {
                            "text": "製造・卸売",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 434.0,
                                            "y": 695.0
                                        },
                                        {
                                            "x": 460.0,
                                            "y": 695.0
                                        },
                                        {
                                            "x": 460.0,
                                            "y": 716.0
                                        },
                                        {
                                            "x": 434.0,
                                            "y": 716.0
                                        }
                                    ]
                                },
                            ]
                        }
                    ],
                    "corpName": [
                        {
                            "text": "株式会社***",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 367.0,
                                            "y": 392.0
                                        },
                                        {
                                            "x": 391.0,
                                            "y": 392.0
                                        },
                                        {
                                            "x": 391.0,
                                            "y": 418.0
                                        },
                                        {
                                            "x": 367.0,
                                            "y": 418.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "corpRegisterNum": [
                        {
                            "text": "******-*********",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 858.0,
                                            "y": 512.0
                                        },
                                        {
                                            "x": 902.0,
                                            "y": 512.0
                                        },
                                        {
                                            "x": 902.0,
                                            "y": 530.0
                                        },
                                        {
                                            "x": 858.0,
                                            "y": 530.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "documentType": [
                        {
                            "text": "事業者登録証",
                            "formatted": {
                                "value": "事業者登録証"
                            },
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 376.0,
                                            "y": 220.0
                                        },
                                        {
                                            "x": 449.0,
                                            "y": 220.0
                                        },
                                        {
                                            "x": 449.0,
                                            "y": 287.0
                                        },
                                        {
                                            "x": 376.0,
                                            "y": 287.0
                                        }
                                    ]
                                }
                            ],
                            "maskingPolys": []
                        }
                    ],
                    "headAddress": [
                        {
                            "text": "ソウル特別市***",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 368.0,
                                            "y": 622.0
                                        },
                                        {
                                            "x": 480.0,
                                            "y": 622.0
                                        },
                                        {
                                            "x": 480.0,
                                            "y": 643.0
                                        },
                                        {
                                            "x": 368.0,
                                            "y": 643.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "issuanceDate": [
                        {
                            "text": "2021年01月07日",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 454.0,
                                            "y": 1299.0
                                        },
                                        {
                                            "x": 520.0,
                                            "y": 1299.0
                                        },
                                        {
                                            "x": 520.0,
                                            "y": 1325.0
                                        },
                                        {
                                            "x": 454.0,
                                            "y": 1325.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "openDate": [
                        {
                            "text": "2001 08 16 日",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 367.0,
                                            "y": 512.0
                                        },
                                        {
                                            "x": 418.0,
                                            "y": 512.0
                                        },
                                        {
                                            "x": 418.0,
                                            "y": 530.0
                                        },
                                        {
                                            "x": 367.0,
                                            "y": 530.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "repName": [
                        {
                            "text": "イ**",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 368.0,
                                            "y": 432.0
                                        },
                                        {
                                            "x": 393.0,
                                            "y": 432.0
                                        },
                                        {
                                            "x": 393.0,
                                            "y": 457.0
                                        },
                                        {
                                            "x": 368.0,
                                            "y": 457.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "taxType": [
                        {
                            "text": "法人事業者",
                            "keyText": "",
                            "confidenceScore": 0.0,
                            "boundingPolys": [
                                {
                                    "vertices": [
                                        {
                                            "x": 532.0,
                                            "y": 282.0
                                        },
                                        {
                                            "x": 564.0,
                                            "y": 282.0
                                        },
                                        {
                                            "x": 564.0,
                                            "y": 328.0
                                        },
                                        {
                                            "x": 532.0,
                                            "y": 328.0
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            }
        }
    ]
}

失敗

呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "code": "0011",
    "message": "Request invalid: Request data() is invalid.",
    "path": "{path}",
    "traceId": "{traceId}",
    "timestamp": 1725349186545
}

この記事は役に立ちましたか?

What's Next

クレジットカード

リクエスト
レスポンス

事業者登録証

リクエスト

リクエストヘッダ

リクエストボディ

Content-Type: application/jsonの場合

Content-Type: multipart/form-dataの場合

images

リクエスト例

Content-Type: application/jsonの場合

Content-Type: multipart/form-dataの場合

レスポンス

レスポンスボディ

images

result

共通オブジェクト情報

文書タイプのオブジェクト情報

boundingPolys

maskingPolys

boundingPolyvertices

レスポンスステータスコード

レスポンス例

成功

失敗

What's Next

`Content-Type: application/json`の場合

`Content-Type: multipart/form-data`の場合

`images`

`Content-Type: application/json`の場合

`Content-Type: multipart/form-data`の場合

`images`

`result`

`boundingPolys`

`maskingPolys`

`boundingPolyvertices`