Проверка адреса проживания пользователя (PoA)

# Проверка адреса проживания пользователя (PoA)

IDnGO предоставляет дополнительную услугу, позволяющую документально подтвердить проживание по указанному адресу и определить подтип подтверждающего документа.

Свяжитесь с нами, если хотите подключить проверку документов, подтверждающих адрес проживания (PoA).

# Получение результатов

Все API-запросы должны быть аутентифицированы, как описано в разделе Начало работы.

# GET Получение основных данных PoA

Чтобы получить данные, распознанные из предоставленных документов, воспользуйтесь одним из этих эндпоинтов:

GET /resources/applicants/{applicantId}/one

или, если вы не знаете applicantId, используйте:

GET /resources/applicants/-;externalUserId={externalUserId}/one

Параметры запроса

Название	Тип	Обязательно	Описание
`applicantId`	String	Да	Идентификатор пользователя.
`externalUserId`	String	Да	Внешний идентификатор пользователя – уникальный идентификатор пользователя на вашей стороне.

Ответ

Массив объектов info.idDocs[] содержит информацию, извлеченную из документов пользователя. Описания ниже будут содержать данные из документов, подтверждающих адрес проживания (PoA), (idDocType: "UTILITY_BILL"). Более подробную информацию о других документах вы можете найти здесь.

Поля массива PoA idDocs

Название	Тип	Обязательно	Описание
`idDocType`	String	Да	Идентификатор типа документа. Для документов PoA: `UTILITY_BILL`/`UTILITY_BILL2`.
`country`	String	Да	Трехбуквенный код страны Альфа-3 (например `RUS`).
`firstName`	String	Нет	Имя и/или фамилия пользователя в зависимости от написания в документе.
`firstNameEn`	String	Нет	Транслитерация имени и/или фамилии пользователя.
`lastName`	String	Нет	Фамилия пользователя.
`lastNameEn`	String	Нет	Транслитерация фамилии пользователя.
`middleName`	String	Нет	Второе имя/отчество.
`middleNameEn`	String	Нет	Транслитерация второго имени/отчества пользователя.
`issuedDate`	String	Нет	Дата выпуска PoA (формат `YYYY-mm-dd`).
`address`	Object	Нет	Поля адреса пользователя.

Поля элемента address

Название	Тип	Описание
`country`	String	Трехбуквенный код страны Альфа-3 (например `RUS`).
`postCode`	String	Почтовый индекс.
`town`	String	Название города или населенного пункта.
`townEn`	String	Транслитерация названия города или населенного пункта.
`street`	String	Название улицы или полный адрес в зависимости от формата в документе.
`streetEn`	String	Транслитерация названия улицы или полного адреса в зависимости от формата в документе.
`subStreet`	String	Дополнительная информация об улице.
`subStreetEn`	String	Транслитерация дополнительной информации об улице.
`state`	String	Название области (округа/республики/штата и т.д.).

Пример

      Запрос
    
      Ответ
    
Copy
curl -X GET \
  'https://api.cyberity.ru/resources/applicants/6b594ade0a975a36c9349e66/one'
{
      "id" : "6b594ade0a975a36c9349e66",
      "createdAt" : "2021-10-27 13:30:14",
      "key" : "ZJTQSEZCZYRMCW",
      "clientId" : "coolclientid",
      "inspectionId" : "6b594ade0a975a36c9349e67",
      "externalUserId" : "29115001",
      "info" : {
        "country" : "GBR",
        "addresses" : [ {
          "subStreet" : "536",
          "subStreetEn" : "536",
          "street" : "Main Street",
          "streetEn" : "Main Stree",
          "state" : "London",
          "town" : "London",
          "townEn" : "London",
          "postCode" : "UK925 63",
          "country" : "GBR"
        } ],
        "idDocs" : [ {
          "idDocType" : "UTILITY_BILL",
          "country" : "SVK",
          "firstName" : "BRADLEY PEAK",
          "firstNameEn" : "BRADLEY PEAK",
          "issuedDate" : "2021-10-10",
          "address" : {
            "subStreet" : "536",
            "subStreetEn" : "536",
            "street" : "Main Street",
            "streetEn" : "Main Stree",
            "state" : "London",
            "town" : "London",
            "townEn" : "London",
            "postCode" : "UK925 63",
            "country" : "GBR"
          }
        } ]
      },
      "ipCountry" : "GBR",
      "requiredIdDocs" : {
        "docSets" : [ {
          "idDocSetType" : "PROOF_OF_RESIDENCE",
          "types" : [ "UTILITY_BILL" ]
        } ]
      },
      "review" : {
        "levelName" : "poaCheck",
        "createDate" : "2021-10-27 14:40:39+0000",
        "reviewDate" : "2021-10-27 15:19:56+0000",
        "startDate" : "2021-10-27 15:17:05+0000",
        "reviewResult" : {
          "reviewAnswer" : "GREEN"
        },
        "reviewStatus" : "completed"
      },
      "lang" : "en",
      "type" : "individual"
    }

# GET Получение дополнительных данных PoA

GET /resources/checks/latest?type=POA&applicantId={applicantId}

Параметры запроса

Название	Тип	Обязательно	Описание
`applicantId`	String	Да	Идентификатор пользователя.

Ответ

Содержит список проверок PoA.

Название	Тип	Обязательно	Описание	Значение
`answer`	String	Да	Результат общей проверки PoA.	`GREEN`/`YELLOW`/`RED`
`poiAsPoa`	Boolean	Нет	Использовался ли документ, удостоверяющий личность, в качестве PoA.	`true`/`false`
`subType`	String	Нет	Подтип PoA.
`companyContact.type`	Object	Нет	Тип организации, которая выдала PoA.

Доступные значения элементов companyContact.type и subType

companyContact.type	subType
`governmentOrganization`	`statement`/`voterRegistration`/`taxBill`/`other`
`utilityProvider`	`telecom`/`utilityBill`/`other`
`bank`	`bankStatement`/`bankLetter`/`other`
`mobileOperator`
`other`	`lease`/`other`

Пример

      Запрос
    
      Ответ
    
Copy
curl -X GET \
  'https://api.cyberity.ru/resources/checks/latest?type=POA&applicantId=6b594ade0a975a36c9349e67'
{
  "checks" : [
    {
      "answer" : "GREEN",
      "checkType" : "POA",
      "createdAt" : "2022-01-11 16:36:23",
      "inputDoc" : {
        "idDocType" : "UTILITY_BILL",
        "country" : "GBR"
      },
      "poaCheckInfo" : {
        "answer" : "GREEN",
        "unexpired" : "GREEN",
        "acceptableType" : "GREEN",
        "validAddress" : "GREEN",
        "companyContact" : {
          "type" : "bank"
        },
        "poiAsPoa" : false,
        "subType" : "bankLetter"
      }
    }
  ]
}