> ## Documentation Index > Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt > Use this file to discover all available pages before exploring further. # Инструкция по интеграции API распознавания и проверки информации удостоверения личности > Identity Authentication 集成指南 - XHuoAPI В данной статье будет представлена инструкция по интеграции API распознавания и проверки информации удостоверения личности, который позволяет проверить подлинность и соответствие имени и номера удостоверения личности, вводя изображение удостоверения личности или имя и номер удостоверения. Этот интерфейс предназначен для проверки подлинности и соответствия имени и номера удостоверения личности, вы можете предоставить необходимую информацию для проверки, введя имя и номер удостоверения или передав фотографию лицевой стороны удостоверения. ## Процесс подачи заявки Чтобы использовать API, сначала необходимо перейти на соответствующую страницу [API распознавания и проверки информации удостоверения личности](https://api.xhuoapi.ai/documents/67f96afa-60b8-4cbb-a4bf-0cbfcf139a23) и подать заявку на соответствующую услугу. После перехода на страницу нажмите кнопку «Acquire», как показано на изображении: ![](https://cdn.xhuoapi.ai/q6ytrc.png) Если вы еще не вошли в систему или не зарегистрированы, вас автоматически перенаправит на страницу входа, где вас пригласят зарегистрироваться и войти. После регистрации и входа вы будете автоматически возвращены на текущую страницу. При первой подаче заявки будет предоставлен бесплатный лимит, который можно использовать для бесплатного доступа к этому API. ## Основное использование Сначала ознакомьтесь с основным способом использования, который заключается в вводе ссылки на изображение удостоверения личности, чтобы получить обработанный результат проверки. Сначала необходимо просто передать поле `image_url`, после чего мы можем заполнить соответствующие данные на интерфейсе, как показано на изображении:

Как видно, здесь мы настроили заголовки запроса, включая: * `accept`: формат ответа, который вы хотите получить, здесь указано `application/json`, то есть формат JSON. * `authorization`: ключ для вызова API, который можно выбрать из выпадающего списка после подачи заявки. Также настроено тело запроса, включая: * `image_url`: ссылка на изображение удостоверения личности, которое нужно обработать. * `encryption`: необязательный параметр шифрования для конфиденциальных данных (если необходимо отправить зашифрованные данные). После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на изображении:

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении, и мы получим следующий результат: ```json theme={null} { "result": "0", "description": "Имя и номер удостоверения совпадают", "name": "Имя на удостоверении", "id_card": "Номер удостоверения", "sex": "Пол на удостоверении", "nation": "Национальность на удостоверении", "birth": "Дата рождения на удостоверении", "address": "Домашний адрес на удостоверении" } ``` Возвращаемый результат содержит несколько полей, описание которых приведено ниже: * `result`, код результата проверки, условия оплаты следующие. * Платные коды результата: * 0: Имя и номер удостоверения совпадают * -1: Имя и номер удостоверения не совпадают * Бесплатные коды результата: * -2: Неверный номер удостоверения (неправильная длина, контрольная цифра и т.д.) * -3: Неверное имя (неправильная длина, формат и т.д.) * -4: Ошибка сервиса базы данных удостоверений * -5: Запись об этом удостоверении отсутствует в базе данных * -6: Система авторитетного сопоставления обновляется, попробуйте позже * -7: Превышено количество проверок за день. * `description`, результат проверки имени и номера удостоверения. * `name`, информация о имени на удостоверении, если изображение удостоверения не было загружено, то поле пустое. * `id_card`, информация о номере удостоверения на удостоверении, если изображение удостоверения не было загружено, то поле пустое. * `sex`, информация о поле на удостоверении, если изображение удостоверения не было загружено, то поле пустое. * `nation`, информация о национальности на удостоверении, если изображение удостоверения не было загружено, то поле пустое. * `birth`, информация о дате рождения на удостоверении, если изображение удостоверения не было загружено, то поле пустое. * `address`, информация о домашнем адресе на удостоверении, если изображение удостоверения не было загружено, то поле пустое. Можно увидеть, что информация о имени и номере удостоверения на удостоверении совпадает и является действительной, также была использована технология OCR для извлечения другой информации и ее отображения. Кроме того, если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом: ```shell theme={null} curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/ocr' \ -H 'accept: application/json' \ -H 'authorization: Bearer {token}' \ -H 'content-type: application/json' \ -d '{ "image_url": {image_url} }' ``` Код интеграции на Python выглядит следующим образом: ```python theme={null} import requests url = "https://api.xhuoapi.ai/v1/identity/idcard/ocr" headers = { "accept": "application/json", "authorization": "Bearer {token}", "content-type": "application/json" } payload = { "image_url": {image_url} } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## Проверка пользовательской информации Мы также предоставляем способ проверки, не раскрывая информацию об изображении удостоверения, можно передать только имя `name` и номер удостоверения `id_card` для проверки подлинности и соответствия имени и номера удостоверения. Ниже приведены конкретные заполненные данные:

После нажатия кнопки запуска мы получаем следующий результат: ```json theme={null} { "address": "", "birth": "", "description": "Имя и номер удостоверения совпадают", "id_card": "Номер удостоверения", "name": "Имя на удостоверении", "nation": "", "result": "0", "sex": "" } ``` Таким образом, из результата не раскрываются другие конфиденциальные данные, что также позволяет проверить подлинность и соответствие имени и номера удостоверения. ## Обработка ошибок При вызове API, если возникнет ошибка, API вернет соответствующий код ошибки и информацию. Например: * `400 token_mismatched`: Неверный запрос, возможно, из-за отсутствия или недействительных параметров. * `400 api_not_implemented`: Неверный запрос, возможно, из-за отсутствия или недействительных параметров. * `401 invalid_token`: Неавторизовано, недействительный или отсутствующий токен авторизации. * `429 too_many_requests`: Слишком много запросов, вы превысили лимит частоты. * `500 api_error`: Внутренняя ошибка сервера, что-то пошло не так на сервере. ### Пример ответа об ошибке ```json theme={null} { "success": false, "error": { "code": "api_error", "message": "fetch failed" }, "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89" } ``` ## Заключение С помощью данного документа вы узнали, как использовать API распознавания и проверки информации удостоверения личности для проверки подлинности и соответствия имени и номера удостоверения на введенных изображениях или информации. Надеемся, что этот документ поможет вам лучше интегрировать и использовать данный API. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.