Download OpenAPI specification:Download
API AF предоставляет возможность загружать в CreditRegistry в онлайн режиме события 2.13.х по антифрод событиям.
| Имя | Значение |
|---|---|
| Endpoint для обращения | http://host:port/credit_registry/antifraud где host:port это адрес стенда CRE в банке, через который будет выполняться отправка событий в БКИ. Загрузка данных выполняется строго POST методом. |
Для аутентификации используются Basic Authentication. Для передачи информации используется HTTP заголовок 'Authorization' с ключевым словом Basic далее пробел и base64 закодированная строка username:password.
| Имя | Значение | Комментарий |
|---|---|---|
| Content-Type | application/json | Указывает тип передаваемого контента |
| Authorization | Basic Логин:Пароль | Basic Логин:Пароль УЗ CRE в base64 |
Для дальнейших действий потребуется:
$ curl --location --request POST 'http://<host>:<port>/credit_registry/antifraud' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
--data-raw '{
"birthDate": "1958-04-02",
"groupCode": "0",
"INN": "934720647096",
"OGRNIP": "326707367485526",
"uid": "000721c1-4ddb-11f1-8000-010000000000-3",
"AFEvent": [{
"amount": "1234.00",
"currency": "USD",
"eventDate": "2023-11-16T10:25:15+03:00",
"eventID": "2.13.1",
"operationCode": "A",
"statusCode": "1",
"statusDate": "2023-11-16"
}, {
"amount": "1234.00",
"currency": "USD",
"eventDate": "2023-11-16T10:30:15+03:00",
"eventID": "2.13.2",
"operationCode": "B",
"statusCode": "2",
"statusDate": "2023-11-16"
}, {
"amount": "1234.00",
"currency": "USD",
"eventDate": "2023-11-16T10:35:15+03:00",
"eventID": "2.13.5",
"operationCode": "B",
"statusCode": "5",
"rejectCode": ["1","8"],
"statusDate": "2023-11-16"
}
]
}'
{
"message": "OK",
"af_ids": [
1,
2,
3
],
"status": true
}
| Authorization required | string Basic Логин:Пароль пользователя CRE в base64 |
| requestId | string <= 256 characters Уникальный идентифкатор запроса. Значение будет продублировано в ответе , также в HTTP заголовке. |
| INN required | string <= 12 characters = 1 items ИНН ФЛ. Поле является ключевым для антифрод-событий по ФЛ. Ожидается на вход только проверенный ИНН. В БКИ для данного ИНН будет выгружаться признак проверенного ИНН. |
| OGRNIP | string <= 15 characters <= 1 items Регистрационный номер индивидуального предпринимателя(ОГРНИП). |
| birthDate required | string <date> = 1 items Дата рождения. Формат: ГГГГ-ММ-ДД |
| groupCode | string <= 19 characters <= 1 items Код группы CRE. Служебное поле для разделения потока данных между разными источниками в рамках одной установки CRE. По умолчанию 0 – Без группы. |
| memberCode | string = 12 characters <= 1 items Код участника НБКИ. Зарезервировано для будущего использования. |
| uid required | string = 38 characters = 1 items [a-f0-9]{8}\-[a-f0-9]{4}\-1[a-f0-9]{3}\-[ab89... УИд обращения для событий 2.13.1, 2.13.2, 2.13.5. УИд сделки для событий 2.13.3, 2.13.4. |
required | Array of objects [ 1 .. 10 ] items Данные по событию/событиям передаваемых по конкретному uid субъекта |
{- "INN": "string",
- "OGRNIP": "string",
- "birthDate": "2019-08-24",
- "groupCode": "string",
- "memberCode": "stringstring",
- "uid": "stringstringstringstringstringstringst",
- "AFEvent": [
- {
- "amount": "string",
- "currency": "str",
- "statusCode": "string",
- "statusDate": "string",
- "eventDate": "string",
- "eventID": "string",
- "operationCode": "string",
- "operationReason": "string",
- "changeReason": "string",
- "rejectCode": [
- "s"
], - "prev": {
- "prevAmount": "string",
- "prevCurrency": "string",
- "prevRejectCode": [
- "s"
], - "prevStatusCode": "string",
- "prevStatusDate": "string",
- "prevUid": "stringstringstringstringstringstringst"
}, - "canExportBRS": "string",
- "canExportNbch": "string",
- "canExportOKB": "string",
- "canExportSB": "string"
}
]
}{- "status": true,
- "message": "ОК",
- "af_ids": [
- 6001,
- 6002,
- 6003
]
}