Верификация данных

Endpoint

Среда	URL
Production	`POST https://api.idcloud.unico.app/lists/{cpf}`
Sandbox	`POST https://api.idcloud.uat.unico.app/lists/{cpf}`

Отдельный endpoint по замыслу

Этот endpoint отделён от стандартного создания процессов (POST /processes/v1). Он возвращает список данных, а не детерминированный результат верификации личности.

Запрос

Заголовки

Заголовок	Значение
`Authorization`	`Bearer <access_token>` (см. Аутентификация)

Параметры пути

Параметр	Тип	Обязательный	Описание
`cpf`	string	да	CPF запрашиваемого лица.

curl -X POST "https://api.idcloud.uat.unico.app/lists/12345678909" \
  -H "Authorization: Bearer $TOKEN"

Ответ

Корневой конверт

{
  "id": "41c24382-36ce-4bb4-8339-352114f71f78",
  "status": 3,
  "lists": { }
}

Поле	Тип	Описание
`id`	string (UUID)	Уникальный идентификатор запроса.
`status`	integer	Статус обработки.
`lists`	object	Основная полезная нагрузка с запрошенными данными.

`lists.basicData` — Регистрационные данные

{
  "basicData": {
    "name": "JOAO DA SILVA",
    "birthCountry": "BRASILEIRA",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "M",
    "motherName": "MARIA DA SILVA",
    "fatherName": "",
    "maritalStatus": "",
    "rgNumber": "",
    "rgIssuingAgency": "",
    "rgStateCode": "",
    "financialData": {
      "incomeEstimate": "...",
      "totalAssets": "..."
    },
    "address": {
      "addressMain": "AVENIDA DO ESTADO",
      "number": "123",
      "complement": "ANDAR 1",
      "neighborhood": "CENTRO",
      "zipCode": "12345678",
      "city": "SAO PAULO",
      "state": "SP",
      "country": "BRASIL",
      "type": "WORK"
    },
    "email": "...",
    "phone": "+554799999999",
    "socialName": ""
  }
}

Поле	Тип	Описание
`name`	string	Полное имя.
`birthCountry`	string	Страна рождения.
`birthDate`	string (ISO 8601)	Дата рождения.
`gender`	string	Пол.
`motherName`	string	Имя матери.
`fatherName`	string	Имя отца.
`maritalStatus`	string	Семейное положение.
`rgNumber`	string	Номер RG.
`rgIssuingAgency`	string	Орган, выдавший RG.
`rgStateCode`	string	Код штата RG.
`financialData.incomeEstimate`	string	Оценка дохода.
`financialData.totalAssets`	string	Общие активы.
`email`	string	Электронная почта.
`phone`	string	Телефон.
`socialName`	string	Социальное имя. Может быть пустым, если у человека нет зарегистрированного социального имени.

basicData.address:

Поле	Тип	Описание
`addressMain`	string	Название улицы.
`number`	string	Номер.
`complement`	string	Дополнение.
`neighborhood`	string	Район.
`zipCode`	string	Почтовый индекс.
`city`	string	Город.
`state`	string	Код штата.
`country`	string	Страна.
`type`	string	Тип адреса (например, `WORK`).

`lists.riskData.taxIdValidation` — Проверка CPF

{
  "taxIdValidation": {
    "taxIdStatus": "REGULAR",
    "taxIdStatusDate": "...",
    "decease": false,
    "under18": false
  }
}

Поле	Тип	Описание
`taxIdStatus`	string	Статус регистрации CPF.
`taxIdStatusDate`	string	Дата статуса регистрации.
`decease`	boolean	Указывает на смерть.
`under18`	boolean	Указывает на несовершеннолетие (до 18 лет).

`lists.riskData.pep` — Политически значимое лицо

{
  "pep": {
    "isCurrentlyPep": true,
    "records": [
      {
        "level": "1",
        "jobTitle": "SENADOR",
        "motive": "FEDERAL EMPLOYEE"
      }
    ]
  }
}

Поле	Тип	Описание
`isCurrentlyPep`	boolean	В настоящее время является PEP.
`records`	array	Собственные записи PEP.
`records[].level`	string	Уровень политической подверженности.
`records[].jobTitle`	string	Должность.
`records[].motive`	string	Основание классификации.

`lists.riskData.aml` — Противодействие отмыванию денег (санкции)

{
  "aml": {
    "isSanctioned": true,
    "records": [
      {
        "type": "Law Enforcement",
        "source": "interpol",
        "standardizedType": "ARREST WARRANTS",
        "endDate": "..."
      }
    ]
  }
}

Поле	Тип	Описание
`isSanctioned`	boolean	Находится под санкциями.
`records`	array	Собственные санкции.
`records[].type`	string	Тип санкции.
`records[].source`	string	Источник санкции.
`records[].standardizedType`	string	Стандартизированный тип.
`records[].endDate`	string	Дата окончания.

`lists.riskData.sportsRelationship` — Связь со спортивными ставками

{
  "sportsRelationship": {
    "hasSportsRelationship": false,
    "isCurrentlyAthlete": false,
    "isCurrentlySportsCoach": false,
    "isCurrentlySportsClubDirector": false,
    "isCurrentlyReferee": false,
    "isCurrentlyRelatedToFinanceMinistry": false,
    "isCurrentlyBettingCompanyOwner": false,
    "sportsRelationshipMotive": "",
    "sportExposures": []
  }
}

Поле	Тип	Описание
`hasSportsRelationship`	boolean	Имеет связь со спортивными организациями.
`isCurrentlyAthlete`	boolean	Является действующим спортсменом.
`isCurrentlySportsCoach`	boolean	Является действующим тренером.
`isCurrentlySportsClubDirector`	boolean	Является действующим директором клуба.
`isCurrentlyReferee`	boolean	Является действующим рефери.
`isCurrentlyRelatedToFinanceMinistry`	boolean	Связан с Министерством финансов.
`isCurrentlyBettingCompanyOwner`	boolean	Является владельцем букмекерской компании.
`sportsRelationshipMotive`	string	Основание связи.
`sportExposures`	array	Подробные сведения о спортивной деятельности.

sportExposures[]:

Поле	Тип	Описание
`sportName`	string	Название вида спорта.
`region`	string	Регион деятельности.
`totalRelatedEntities`	integer	Общее число связанных организаций.
`relationshipLevel`	string	Уровень связи.
`endDate`	string	Дата окончания.

Коды ошибок

400 Bad Request
403 Forbidden
500 Internal Server Error

Код	Сообщение	Описание
`99989`	The document is invalid.	Когда CPF недействителен.

Код	Сообщение	Описание
`10501`	The authorization token is invalid.	Токен аутентификации недействителен.

Код	Сообщение	Описание
`99999`	Internal failure! Try again later	Внутренняя ошибка сервера.

Endpoint​

Запрос​

Ответ​

Коды ошибок​

Endpoint

Запрос

Ответ

Коды ошибок