Единый веб-сервис проверок.

Единый веб-сервис проверок. 1.2.0

0
No votes yet

Описание схемы работы API.

Для осуществления проверки необходимо добавить её в массив checks в теле запроса, вписав название в поле checkName. Названия проверок приведены в таблице ниже:

Название Описание
WSConsumerSubjectInfoGet Получение данных о субъекте из мастер-системы, хранящей оперативную клиентскую информацию
WSCodeInvalidIdentityCard Проверка клиента через сервис недействительных паспортов
WSCustomerBankruptcyInfo Проверка клиента через сервис банкротств
WSCustomerReputationRisk Проверка клиента через сервис репутационных рисков
WSCustomerTerrorism Проверка клиента на присутствие в базах, причастных к терроризму
WSGlobalSearch Проверка клиента на возможность получения лизинга
WSResultSOZSalaryProject Проверка клиента на благонадежность в зарплатном проекте
WSCustomerComplianceCheckGet Осуществление проверки блокировок по черным спискам

На вход в Единый сервис проверок (ЕСП) передаются следующие данные:

Параметр Расшифровка Комментарий
exs Код внешней системы
Блок checks.checkName Имя сервиса См. предыдущую таблицу по названиям проверок
Блок checks.isToCall Вызывать или нет true - вызывать, false - не вызывать
idg Код системы Необходим для вызова проверки WSCustomerComplianceChecks
chklst Код проверки Необходим для вызова проверки WSCustomerComplianceChecks. Если необходимо выполнить несколько проверок, то перечисляются через запятую без пробелов, например, "chklst":"N04,S01,C02"
cus Идентификатор клиента
fnm1 Фамилия
fnm2 Имя
fnm3 Отчество
dtbr Дата рождения
ucd Тип документа, удостоверяющего личность (ДУЛ)
ser Серия ДУЛ
num Номер ДУЛ
dopn Дата выдачи ДУЛ
edt Дата окончания ДУЛ
ucdoТип старого ДУЛ Временно не используется
sero Серия старого ДУЛ Временно не используется
numo Номер старого ДУЛ Временно не используется
crf ИНН ЮЛ/ФЛ
fior СНИЛС
cod
ecs Описание вызывающей системы
cban Код блокировки

Приняты следующие коды результатов проверок (указываются в checks/имя проверки/result):

Код проверки Расшифровка
E Проверка не выполнялась
N Проверка успешна (клиент НЕ является банкротом, НЕ имеет недействительный паспорт и т.п.)
Y Проверка неуспешна (клиент является банкротом, имеет недействительный паспорт и т.п.)

Возможные сообщения:

  • Возможные сообщения по сервисам WSCustomerComplianceCheckGet, WSCodeInfvalidIdentityCard, WSCustomerBankruptcyInfo, WSCustomerReputationRisk, WSCustomerTerrorism, WSCunsumerSubjectInfoGet
Код Описание
KSM0006 Входная переменная не найдена
PBC0999 Ошибка выполнения оператора SQL
PBS0000 Результат не определен
PBS0001 Дата актуализации действительная
PBS0002 Дата актуализации не действительная
PBS0003 Дата действия доверенности УЛ не истекла
PBS0004 Дата действия доверенности УЛ истекла
PBS0005 Паспорт клиента РФ действителен
PBS0006 Паспорт клиента РФ не действителен
PBS0007 Срок действия паспорта РФ не истек
PBS0008 Срок действия паспорта РФ истек
PBS0009 Срок действия загранпаспорта не истек
PBS0018 Найдено полное соответствие в списке репутационных рисков
PBS0019 Найдено частичное соответствие в списке репутационных рисков
PBS0020 Соответствие не найдено в списке репутационных рисков
PBS0021 Найдено полное соответствие в списке террористов\экстремистов
PBS0022 Найдено частичное соответствие в списке террористов\экстремистов
PBS0023 Соответствие не найдено в списке террористов\экстремистов
PBS0025 Найдено соответствие в списке репутационных рисков ЮЛ/ИП
PBS0027 Действующих рисков не обнаружено
PBS0047 Найдено полное соответствие в санкционном списке
PBS0049 Санкционные коды риска не найдены
PBS0100 Недостаточно входных параметров
PBS0101 Некорректные входные парам
WSE9999 Ошибка установки соединения
  • Возможные сообщения по сервису WSGlobalSearch
Код Описание
0 Нет ошибок
1 Авторизация не пройдена
2 Нет данных для авторизации
3 Отсутствует ИНН ЮЛ
4 Отсутствует информация о ФЛ (ФИО и день рождения или номер документа удостоверяющего личность)
5 Возникла ошибка при проверке ЮЛ по ИНН
6 Возникла ошибка при проверке ФЛ по ФИО и день рождения
7 Возникла ошибка при проверке ФЛ по ДУЛ
8 ИНН менее 10 символов
9 Размер документа удостоверяющего личность отличен от 10 символов
  • Возможные сообщения по сервису WSResultSOZSalaryProject
Код Описание
0 Нет ошибок
1 Авторизация не пройдена
2 Нет данных для авторизации
3 Отсутствует ИНН ЮЛ
4 По данному ЮЛ присутствует запрос в работе
5 Возникла ошибка при поиске сведений об ЮЛ
6 У запроса истек срок действия заключения Службы экономической безопасности
7 По данному ЮЛ в Cистеме обработки заявок отсутствует запрос
  • Список возможных ошибок.
  1. Некорректный запрос:
    • HTTP код: 400
    • { "httpCode": "400", "httpMessage": "Bad Request", "moreInformation": "Error description" }
  2. Некорректный заголовок x-ibm-client-id:
    • HTTP код: 401
    • { "httpCode": "401", "httpMessage": "Unauthorized", "moreInformation": "Application is not registered with mutual tls" }
  3. Не предоставлен разрешенный сертификат:
    • HTTP код: 401
    • { "httpCode": "401", "httpMessage": "Unauthorized", "moreInformation": "Invalid client certificate is provided" }
  4. Ошибка валидации:
    • HTTP код: 422
    • { "httpCode": "422", "httpMessage": "Invalid", "moreInformation": "Validate REST: ... ." }
  5. Внутренняя техническая ошибка:
    • HTTP код: 500.
    • {"Error": { "ErrorCode": 0, "ErrorString": "WSTechnicalException", "ErrorTrace": "Error trace" }}
  6. Внутренняя техническая ошибка:
    • HTTP код: 500
    • { "httpCode": "500", "httpMessage": "Internal Server Error", "moreInformation": "Error description" }
  7. Система Единый веб-сервис проверок недоступна:
    • HTTP код 500 -{ "httpCode": "500", "httpMessage": "URL Open error", "moreInformation": "Could not connect to endpoint" }
  • Примеры запросов:

Пример 1:

{ "exs": "WBI_ZP", "checks": [ { 

  "checkName": "WSCustomerBankruptcyInfo", 
  "isToCall": "true"

}, { 

  "checkName": "WSCustomerComplianceCheckGet", 
  "isToCall": "true"

}, { 

  "checkName": "WSConsumerSubjectInfoGet", 
  "isToCall": "true"

}, { 

  "checkName": "WSGlobalSearch", 
  "isToCall": "true"

}, { 

  "checkName": "WSCodeInvalidIdentityCard", 
  "isToCall": "true"

}, { 

  "checkName": "WSCustomerReputationRisk", 
  "isToCall": "true"

}, { 

  "checkName": "WSResultSOZSalaryProject", 
  "isToCall": "true"

}, { 

  "checkName": "WSCustomerTerrorism", 
  "isToCall": "true"

} ], 

"idg": "123456", 
"cus": "AAAAAA", 
"fnm1": "Familiya", 
"fnm2": "Imya", 
"fnm3": "Otchestvo", 
"dtbr": "1979-12-31", 
"ucd": "001", 
"ser": "1", 
"num": "1", 
"ucdo": "01", 
"sero": "11AA", 
"numo": "222333", 
"crf": "123456789012", 
"fior": "12345678900",
"chklst":"N04,S01,C02",
"customerType":"FL"

}

Пример 2:

{ "exs": "WBI_ZP", "checks": [
{ 

  "checkName": "WSCustomerComplianceCheckGet", 
  "isToCall": "true"

}, { 

  "checkName": "WSCodeInvalidIdentityCard", 
  "isToCall": "true"

}, { 

  "checkName": "WSCustomerReputationRisk", 
  "isToCall": "true"

} ], 

"fnm1": "Familiya", 
"fnm2": "Imya", 
"fnm3": "Otchestvo", 
"ucd": "001", 
"ser": "2351", 
"num": "666555", 
"chklst":"N04"
"customerType":"FL"

}

expand_moreexpand_lessContact information
Рабочая группа по функциональной части работы сервиса
forum Discuss this API in the forum
production
https://apiwsg.alfabank.ru/alfabank/alfadevportal

TLS ГОСТ Промышленный режим

development
https://apiwsgdev.alfabank.ru/alfabank/alfadevportal

TLS ГОСТ Режим разработки

production
development
https://apiws.alfabank.ru/alfabank/alfadevportal

TLS RSA

Paths

/WSCustomerCommonChecksJSON

post /WSCustomerCommonChecksJSON

Запрос на выполнение проверок

clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
body
Required in body
object

Информация о необходимых проверках

Request
x-client-certificate
Required in header
string

Сертификат в Base64 формате

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Response

Response
500

WSTechnicalException

WSTechnicalException
Example Request
Example Response
POST https://apiwsg.alfabank.ru/alfabank/alfadevportal/CS/EQ/WSCustomerCommonChecks/WSCustomerCommonChecksJSON
Try this operation
https://apiwsg.alfabank.ru/alfabank/alfadevportal/CS/EQ/WSCustomerCommonChecks/WSCustomerCommonChecksJSON
content-type
accept
x-client-certificate

Definitions

Формат проверки (элемента массива checks), содержащейся в запросе к Единому веб-сервису проверок.

{
    "type": "object",
    "properties": {
        "checkName": {
            "type": "string",
            "description": "Название проверки",
            "example": "WSGlobalSearch"
        },
        "isToCall": {
            "type": "string",
            "example": "true",
            "enum": [
                "true",
                "false",
                "0",
                "1"
            ],
            "description": "Флаг необходимости осуществления проверки"
        }
    }
}

Формат запроса к Единому веб-сервису проверок.

{
    "type": "object",
    "properties": {
        "exs": {
            "type": "string",
            "maxLength": 10,
            "description": "Код внешней системы",
            "example": "WBI_ZP"
        },
        "checks": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/CheckIn"
            },
            "minItems": 1,
            "description": "Массив проверок"
        },
        "idg": {
            "type": "string",
            "example": "NC1",
            "maxLength": 3,
            "description": "Имя проверки для WSCustomerComplianceCheckGet"
        },
        "cus": {
            "type": "string",
            "example": "AA0000",
            "maxLength": 6,
            "description": "Код клиента"
        },
        "clc": {
            "type": "string",
            "description": "Местоположение клиента",
            "maxLength": 3
        },
        "fnm1": {
            "type": "string",
            "example": "Иванов",
            "description": "Фамилия",
            "maxLength": 35
        },
        "fnm2": {
            "type": "string",
            "example": "Сергей",
            "description": "Имя",
            "maxLength": 35
        },
        "fnm3": {
            "type": "string",
            "example": "Юрьевич",
            "description": "Отчество",
            "maxLength": 35
        },
        "dtbr": {
            "type": "string",
            "example": "1993-11-21",
            "format": "date",
            "description": "Дата рождения"
        },
        "mtbr": {
            "type": "string",
            "description": "Место рождения",
            "maxLength": 70
        },
        "ucd": {
            "type": "string",
            "description": "Вид документа",
            "maxLength": 3,
            "example": "001"
        },
        "ser": {
            "type": "string",
            "description": "Серия документа",
            "maxLength": 10,
            "example": "45 05"
        },
        "num": {
            "type": "string",
            "description": "Номер документа",
            "maxLength": 35,
            "example": "325412"
        },
        "ucdo": {
            "type": "string",
            "description": "Вид документа (старого)",
            "maxLength": 3
        },
        "dopn": {
            "type": "string",
            "example": "2011-11-21",
            "format": "date",
            "description": "Дата получения документа"
        },
        "edt": {
            "type": "string",
            "example": "2011-11-21",
            "format": "date",
            "description": "Дата завершения срока действия документа"
        },
        "sero": {
            "type": "string",
            "description": "Серия документа (старого)",
            "maxLength": 10
        },
        "numo": {
            "type": "string",
            "description": "Номер документа (старого)",
            "maxLength": 35
        },
        "crf": {
            "type": "string",
            "description": "ИНН",
            "maxLength": 20
        },
        "fior": {
            "type": "string",
            "description": "СНИЛС",
            "maxLength": 35
        },
        "ecs": {
            "type": "string",
            "description": "Код процесса/системы",
            "maxLength": 4
        },
        "cban": {
            "type": "string",
            "maxLength": 4
        },
        "chklst": {
            "type": "string",
            "description": "Список проверок для WSCustometCompilianceCheck через запятую",
            "maxLength": 250,
            "example": "N04,S01,C02"
        },
        "customerType": {
            "type": "string",
            "description": "Тип субъекта UL\\IP\\FL",
            "example": "FL"
        }
    },
    "required": [
        "exs",
        "checks"
    ]
}

Формат проверки (элемента массива checks), содержащейся в ответе Единого веб-сервиса проверок.

{
    "type": "object",
    "properties": {
        "checkName": {
            "type": "string",
            "example": "WSGlobalSearch",
            "description": "Название проверки"
        },
        "isToCall": {
            "type": "string",
            "example": "Y",
            "maxLength": 1,
            "description": "Флаг необходимости осуществления проверки"
        },
        "checkResult": {
            "type": "string",
            "example": "E",
            "description": "Результат проверки",
            "maxLength": 10
        },
        "matched": {
            "type": "object",
            "properties": {
                "tagName": {
                    "type": "string",
                    "description": "имя совпавшего тега",
                    "maxLength": 100
                }
            }
        },
        "comment": {
            "type": "string",
            "description": "Комментарий к проверке",
            "maxLength": 100
        },
        "idg": {
            "type": "string",
            "maxLength": 3
        }
    }
}

Формат ответа Единого веб-сервиса проверок.

{
    "type": "object",
    "properties": {
        "outParms": {
            "type": "object",
            "properties": {
                "checks": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/CheckOut"
                    }
                },
                "outParmsWSComplianceCheck": {
                    "type": "object",
                    "properties": {
                        "fres": {
                            "type": "string",
                            "maxLength": 1
                        },
                        "ResultSet1": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/ResultSet1Row"
                            }
                        },
                        "ResultSet2": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/ResultSet2Row"
                            }
                        },
                        "ResultSet3": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/ResultSet3Row"
                            }
                        }
                    }
                }
            }
        }
    }
}

Набор полей №1, возвращаемых в ответе.

{
    "type": "object",
    "properties": {
        "idp": {
            "type": "string",
            "maxLength": 3,
            "description": "Код проверки"
        },
        "idr": {
            "type": "string",
            "maxLength": 7,
            "description": "Код результата"
        },
        "nms": {
            "type": "string",
            "maxLength": 70,
            "description": "Описание результата"
        },
        "chk": {
            "type": "string",
            "maxLength": 1,
            "description": "Результат отдельной проверки"
        },
        "atr": {
            "type": "object",
            "description": "Атрибуты проверок"
        }
    }
}

Набор полей №2, возвращаемых в ответе.

{
    "type": "object",
    "properties": {
        "fnm": {
            "type": "string",
            "maxLength": 105,
            "description": "ФИО",
            "example": "Иванов Сергей Юрьевич"
        },
        "dtbr": {
            "type": "string",
            "example": "2001-11-21",
            "format": "date",
            "description": "Дата рождения"
        },
        "ucd": {
            "type": "string",
            "maxLength": 3,
            "description": "Вид документа",
            "example": "001"
        },
        "ser": {
            "type": "string",
            "maxLength": 10,
            "description": "Серия документа",
            "example": "0519"
        },
        "num": {
            "type": "string",
            "maxLength": 35,
            "description": "Номер документа",
            "example": "198053"
        },
        "org": {
            "type": "string",
            "maxLength": 100,
            "description": "Кем выдан документ",
            "example": "651-858"
        },
        "opn": {
            "type": "string",
            "example": "2011-11-21",
            "format": "date",
            "description": "Дата выдачи документа"
        },
        "fior": {
            "type": "string",
            "maxLength": 20,
            "description": "СНИЛС",
            "example": "12364892019"
        },
        "crf": {
            "type": "string",
            "maxLength": 15,
            "description": "ИНН",
            "example": "985986254621"
        },
        "ban": {
            "type": "string",
            "maxLength": 2,
            "description": "Код запрета"
        }
    }
}

Набор полей №3, возвращаемых в ответе.

{
    "type": "object",
    "properties": {
        "fnm": {
            "type": "string",
            "maxLength": 105,
            "description": "ФИО",
            "example": "Иванов Сергей Юрьевич"
        },
        "dtbr": {
            "type": "string",
            "example": "2001-11-21",
            "format": "date",
            "description": "Дата рождения"
        },
        "ucd": {
            "type": "string",
            "maxLength": 3,
            "description": "Вид документа",
            "example": "001"
        },
        "ser": {
            "type": "string",
            "maxLength": 10,
            "description": "Серия документа",
            "example": "0846"
        },
        "num": {
            "type": "string",
            "maxLength": 35,
            "description": "Номер документа",
            "example": "465213"
        },
        "org": {
            "type": "string",
            "maxLength": 100,
            "description": "Кем выдан документ",
            "example": "215-031"
        },
        "amr": {
            "type": "string",
            "maxLength": 254,
            "description": "Адрес регистрации",
            "example": "г. Ставрополь, ул. Ленина, 26, кв.4"
        },
        "mr": {
            "type": "string",
            "maxLength": 254,
            "description": "Место рождения",
            "example": "г. Ставрополь"
        },
        "crf": {
            "type": "string",
            "maxLength": 15,
            "description": "ИНН",
            "example": "12364892019"
        },
        "ter": {
            "type": "string",
            "maxLength": 20,
            "description": "Признак террориста",
            "example": "0"
        }
    },
    "additionalProperties": false
}

Формат ошибки.

{
    "type": "object",
    "properties": {
        "Error": {
            "type": "object",
            "properties": {
                "ErrorCode": {
                    "type": "integer"
                },
                "ErrorString": {
                    "type": "string",
                    "description": "Имя ошибки"
                },
                "ErrorTrace": {
                    "type": "string",
                    "description": "Описание ошибки"
                }
            }
        }
    }
}