Сервис «Получение кредитного отчета универсального формата»: различия между версиями
(BAZAZNANIY-73) |
(нет различий)
|
Версия от 12:54, 27 сентября 2023
Главная страница | Предыдущая страница |
В данной статье описывается автоматическое получение отчетов формата UniversalService, его методы, примеры входных и выходных SOAP-запросов, возможные ошибки и описание самих отчетов.
Содержание
- 1 ПОЛУЧЕНИЕ КРЕДИТНЫХ ОТЧЕТОВ (CreditReportUniversalService)
- 2 Ошибки при получении отчетов
- 3 ОПИСАНИЕ ОТЧЕТОВ
- 3.1 Структура идентификационного отчета для физического лица
- 3.2 Структура идентификационного отчета для юридического лица
- 3.3 Структура первичного отчета для физического лица
- 3.4 Структура первичного отчета для юридического лица
- 3.5 Структура стандартного отчета для физического лица
- 3.6 Структура стандартного отчета для юридического лиц
- 3.7 Структура расширенного отчета для физического лица
- 3.8 Структура расширенного отчета для юридического лица
- 3.9 Структура негативного отчета для физического лица
- 3.10 Структура негативного отчета для юридического лица
- 3.11 Структура отчета об отсутствии информации для физического лица
- 3.12 Структура отчета об отсутствии информации для юридического лица
- 4 Приложение 1
ПОЛУЧЕНИЕ КРЕДИТНЫХ ОТЧЕТОВ (CreditReportUniversalService)
- Идентификационный отчет – отчет должен быть доступен только при наличии у субъекта хотя бы одного активного контракта в любой фазе.
- Первичный отчет – отчет должен быть доступен только при наличии у субъекта хотя бы одного активного контракта в любой фазе.
- Стандартный отчет – отчет доступен только при наличии у субъекта хотя бы одного активного контракта в фазе "Действующий".
- Расширенный отчет – отчет доступен только при наличии у субъекта хотя бы одного активного контракта в фазе "Завершен", "Завершен досрочно".
- Негативный отчет – Негативный отчет доступен для формирования, если субъект связан хотя бы с одним активным контрактом, имеющим просроченную задолженность свыше 90 (девяноста) календарных дней на последнюю учетную дату.
Примечание: в случае, если у субъекта нет ни одного активного контракта, система должна предлагать Отчет об отсутствии информации по субъекту. До формирования кредитных отчетов всех типов, за исключением негативного и отчета об отсутствии информации, необходимо подтвердить наличие согласия субъекта кредитной истории на выдачу кредитного отчета получателю кредитного отчета.
В данном разделе описываются методы Web-сервисов для внешнего использования, точнее получение отчетов формата UniversalService, используя SOAP-запросы. Сервис предназначен для получения перечня разрешенных типов отчетов и формирования кредитных отчетов. Этот сервис используется только для внешних вызовов.
- 1) getCreditReportTypes;
- 2) requestXmlCreditReport.
- 1) ID и пароль клиента (организации) в HTTP header, необходимый для базовой аутентификации. Так как коммуникация с веб сервисами системы идет по защищенному протоколу HTTPS, базовая аутентификация представляется безопасным решением.
- 2) ID пользователя, от имени которого будет выполнена запрашиваемая операция, в SOAP header:
Http Headers: {Authorization=[Basic c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2]}
SOAP Message:
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:um="http://um.scb.kz">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <um:getAllCustomers/>
7. </soapenv:Body>
8. </soapenv:Envelope>
Где c3ZjUnB0U3lzdGVtQWNjb3VudDpBbzZVRkdyVTZ2 – есть значение HTTP header, представляющее собой ID клиента и его пароль в формате «clientId:password» и кодировке Base64 как того требует механизм basic authentication.
Метод getCreditReportTypes
Метод возвращает возможные типы отчетов для указанного субъекта.
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="http://report.chdb.scb.kz" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <rep:getCreditReportTypes>
7. <reportParams xsi:type="rep:personCreditReportParams">
8. <iin>ИИН</iin>
9. <!--<personId>Идентификатор физического лица</personId>-->
10. </reportParams>
11. <language>ru</language>
12. </rep:getCreditReportTypes>
13. </soapenv:Body>
14. </soapenv:Envelope>
Примечание: значение userId смотрите в форме доступа.
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="http://report.chdb.scb.kz" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <rep:getCreditReportTypes>
7. <reportParams xsi:type="rep:organizationCreditReportParams">
8. <bin>БИН</bin>
9. <consentConfirmed>true</consentConfirmed>
10. <!--<organizationId>Идентификатор юридического лица</organizationId>-->
11. </reportParams>
12. <language>ru</language>
13. </rep:getCreditReportTypes>
14. </soapenv:Body>
15. </soapenv:Envelope>
Примечание: значение userId смотрите в форме доступа.
|
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx</userId>
4. <creditorId>93</creditorId>
5. <timestamp>1664962488868</timestamp>
6. </SOAP-ENV:Header>
7. <soap:Body>
8. <ns2:getCreditReportTypesResponse xmlns:ns2="http://report.chdb.scb.kz">
9. <availableReportTypes xsi:type="ns2:formatXReportWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
10. <CigResult Version="3.0.1">
11. <DateTime>05.10.2022 15:34:48</DateTime>
12. <ReferenceId/>
13. <ServiceName>Front Office WS</ServiceName>
14. <ResultCulture>ru-RU</ResultCulture>
15. <ResultCode/>
16. <ResultDescription/>
17. <UsageIdentity/>
18. <Result>
19. <EntitiesAndReports>
20. <Entity id="0" name="Фамилия Имя Отчество" typeid="241">
21. <Reports>
22. <Report id="200004" importcode="7" name="Идентификационный отчет"/>
23. <Report id="200000" importcode="2" name="Кредитный отчет - первичный"/>
24. <Report id="200017" importcode="4" name="Кредитный отчет - стандартный"/>
25. <Report id="200019" importcode="6" name="Кредитный отчет - расширенный"/>
26. <Report id="200066" importcode="13" name="Отчет, содержащий негативную информацию"/>
27. </Reports>
28. </Entity>
29. </EntitiesAndReports>
30. </Result>
31. </CigResult>
32. </availableReportTypes>
33. </ns2:getCreditReportTypesResponse>
34. </soap:Body>
35. </soap:Envelope>
1. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
2. <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx</userId>
4. <creditorId>93</creditorId>
5. <timestamp>1665372766202</timestamp>
6. </SOAP-ENV:Header>
7. <soap:Body>
8. <ns2:getCreditReportTypesResponse xmlns:ns2="http://report.chdb.scb.kz">
9. <availableReportTypes xsi:type="ns2:formatXReportWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
10. <CigResult Version="3.0.1">
11. <DateTime>10.10.2022 09:32:46</DateTime>
12. <ReferenceId/>
13. <ServiceName>Front Office WS</ServiceName>
14. <ResultCulture>ru-RU</ResultCulture>
15. <ResultCode/>
16. <ResultDescription/>
17. <UsageIdentity/>
18. <Result>
19. <EntitiesAndReports>
20. <Entity id="0" name="Наименование субъекта" typeid="242">
21. <Reports>
22. <Report id="200013" importcode="7" name="Идентификационный отчет"/>
23. <Report id="99993" importcode="1" name="Кредитный отчет - первичный"/>
24. <Report id="200014" importcode="3" name="Кредитный отчет - стандартный"/>
25. <Report id="200018" importcode="5" name="Кредитный отчет - расширенный"/>
26. <Report id="200067" importcode="14" name="Отчет, содержащий негативную информацию"/>
27. </Reports>
28. </Entity>
29. </EntitiesAndReports>
30. </Result>
31. </CigResult>
32. </availableReportTypes>
33. </ns2:getCreditReportTypesResponse>
34. </soap:Body>
35. </soap:Envelope>
|
Исключительные ситуации.
Метод getReportTypes может возвращать ошибки типа:
- 1) ScbSystemFault (подробное описание ошибки см. в разделе 2)
- 2) ScbBusinessFault (подробное описание ошибки см. в разделе 2)
Примечание: Для корректной работы необходимо передавать только один из двух входных параметров.
Метод requestXmlCreditReport
Метод выполняет формирование отчета в формате XML на основе заданных параметров и регистрацию запроса отчета в биллинге.
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="http://report.chdb.scb.kz" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <rep:requestXmlCreditReport>
7. <reportRequest>
8. <generationParams>
9. <language>ru</language>
10. <outputFormats>XML</outputFormats>
11. <reportType>Тип кредитный отчета</reportType>
12. </generationParams>
13. <reportParams xsi:type="rep:personCreditReportParams">
14. <iin>ИИН</iin>
15. <!--<personId> Идентификатор физического лица </personId>-->
16. <consentConfirmed>true</consentConfirmed>
17. </reportParams>
18. </reportRequest>
19. </rep:requestXmlCreditReport>
20. </soapenv:Body>
21. </soapenv:Envelope>
Примечание: значение userId смотрите в форме доступа.
1. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:rep="http://report.chdb.scb.kz" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2. <soapenv:Header>
3. <userId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx</userId>
4. </soapenv:Header>
5. <soapenv:Body>
6. <rep:requestXmlCreditReport>
7. <reportRequest>
8. <generationParams>
9. <language>ru</language>
10. <outputFormats>XML</outputFormats>
11. <reportType>extendedReport</reportType>
12. </generationParams>
13. <reportParams xsi:type="rep:organizationCreditReportParams">
14. <bin>БИН</bin>
15. <!--<organizationId>Идентификатор юридического лица</organizationId>-->
16. <consentConfirmed>true</consentConfirmed>
17. </reportParams>
18. </reportRequest>
19. </rep:requestXmlCreditReport>
20. </soapenv:Body>
21. </soapenv:Envelope>
Примечание: значение userId смотрите в форме доступа.
|
Выходные параметры:
- Прямо в теле SOAP-ответа будут возвращены данные по запрашиваемому отчету. Структура и описание возвращаемых данных приведены по ссылкам:
- 1) Идентификационный отчет для физического лица;
- 2) Идентификационный отчет для юридического лица;
- 3) Первичный отчет для физического лица;
- 4) Первичный отчет для для юридического лица;
- 5) Стандартный отчет для физического лица;
- 6) Стандартный отчет для для юридического лица;
- 7) Расширенный отчет для физического лица;
- 8) Расширенный отчет для для юридического лица;
- 9) Негативный отчет для физического лица;
- 10) Негативный отчет для для юридического лица;
Исключительные ситуации:
- Метод requestXmlCreditReport может возвращать ошибки типа:
- 1) ScbSystemFault (подробное описание ошибки см. в разделе 2)
- 2) ScbBusinessFault (подробное описание ошибки см. в разделе 2)
- 3) ScbValidationFault (подробное описание ошибки см. в разделе 2)
Параметры для поиска
Поиск субъекта осуществляется по одному или нескольким параметрам. В методах можно передавать один номер документа типа ИИН/БИН и различные типы кредитных отчетов. Также можно передавать различные номера документа типа ИИН/БИН, при этом получать разные типы кредитных отчетов.
|
|
|
|
Ошибки при получении отчетов
Веб-сервис для получения отчетов ПО БДКИ может возвращать следующие виды ошибок:
ScbSystemFault – непредвиденные ошибки, которые могут возникнуть при работе с ПО БДКИ. Например, ошибки подключения к каким-то ресурсам, сетевые ошибки, ошибки недостаточности памяти, и т.д.
Таблица 8. Ошибки при получении отчетов (ScbSystemFault)
Наименование | Тип | Описание |
---|---|---|
faultCode | xs:string | Код ошибки |
faultDescription | xs:string | Описание ошибки |
faultId | xs:string | Уникальный идентификатор ошибки |
faultTimestamp | xs:dateTime | Дата, время ошибки |
faultType | xs:string | Тип ошибки
DATABASE_ERROR HTTP_CONNECTION_PROBLEM LDAP_CONNECTION_PROBLEM JMS_CONNECTION_PROBLEM FILE_IO_ERROR PROGRAMMATIC_ERROR UNEXPECTED_INTERNAL_ERROR |
ScbBusinessFault – предсказуемые ошибки, связанные, как правило, с бизнес-ло-гикой работы ПО БДКИ. Например, бизнес-проверки, проверки безопасности, данные не найдены, и т.д.
Таблица 9. Ошибки при получении отчетов (ScbBusinessFault
Наименование | Тип | Описание |
---|---|---|
faultCode | xs:string | Код ошибки |
faultDescription | xs:string | Описание ошибки |
faultId | xs:string | Уникальный идентификатор ошибки |
faultTimestamp | xs:dateTime | Дата, время ошибки |
faultType | xs:string | Тип ошибки
DATA_NOT_FOUND FILE_NOT_FOUND ACCESS_DENIED VALIDATION_ERROR INTEGRITY_CHECK CONCURRENT_MODIFICATION |
ScbValidationFault – ошибки, возникающие при проверке корректности данных. Например, нарушение drools-правил, превышение размерности данных и т.д.
Таблица 10. Ошибки при получении отчетов (ScbValidationFault)
Наименование | Тип | Описание |
---|---|---|
code | xs:string | Код ошибки |
ОПИСАНИЕ ОТЧЕТОВ
Данный раздел описывает XML представление кредитных отчетов с описание полей, содержащихся в отчетах.
Структура идентификационного отчета для физического лица
Идентификационный отчет не содержит данных по контрактам субъекта, он предназначен для предоставления персональных данных, адресной и контактной информации по субъекту.
- 1) Персональные данные;
- 2) Адресная информация – постоянное место жительства;
- 3) Текущая информация о документах;
- 4) Историческая информация о документах;
- 5) Сведения о компаниях, в которых субъект является первым руководителем;
- 6) Сведения из публичных источников;
- 7) Сведения о наличии стоп кредита;
|
Структура идентификационного отчета для юридического лица
Идентификационный отчет не содержит данных по контрактам субъекта, он предназначен для предоставления персональных данных, адресной и контактной информации по субъекту.
- 1) Персональные данные с указанием места регистрации и сведений о первых руководителях компании;
- 2) Адресная информация (текущая и историческая)
- 3) Информация о документах (текущая и историческая);
- 4) Сведения из публичных источников.
|
Структура первичного отчета для физического лица
Первичный отчет предоставляет более широкий набор информации, нежели идентификационный отчет.
- 1) Персональные данные;
- 2) Адресная информация;
- 3) Информация о документах (текущая и историческая);
- 4) Социально-экономический статус для физического лица;
- 5) Общая информация по обязательствам (блок содержит информацию по количеству контрактов каждого типа, роли субъекта, непогашенной, просроченной сумме и т.д.) (в том числе по обязательствам перед операторами сотовой связи);
- 6) Количество запросов по кредитной истории;
- 7) Сведения о компаниях, в которых субъект является первым руководителем;
- 8) Сведения из публичных источников;
- 9) Сведения о наличии стоп кредита;
|
Структура первичного отчета для юридического лица
Первичный отчет предоставляет более широкий набор информации, нежели идентификационный отчет.
- 1) Персональные данные с указанием актуальных документов, места регистрации и первых руководителях компании;
- 2) Адресная информация – текущая и историческая;
- 3) Информация о документах – текущая и историческая;
- 4) Сведения о компании;
- 5) Общая информация по обязательствам (блок содержит информацию по количеству контрактов каждого типа, роли субъекта, непогашенной, просроченной сумме и т.д., в том числе по обязательствам перед операторами сотовой связи);
- 6) Количество запросов по кредитной истории;
- 7) Сведения из публичных источников;
|
Структура стандартного отчета для физического лица
- 1) Персональные данные;
- 2) Адресная информация;
- 3) Информация о документах (текущая и историческая);
- 4) Социально-экономический статус для физического лица;
- 5) Общая информация по обязательствам (блок содержит информацию по количеству контрактов каждого типа, роли субъекта, непогашенной, просроченной сумме и т.д.) (в том числе по обязательствам перед операторами сотовой связи);
- 6) Подробная информация по действующим обязательствам (обязательство, обеспечение по обязательству, дополнительная информация, связанные субъекты, график количества просроченных дней и платежей (дни, сумма в валюте договора), общая информация о просроченной задолженности) (в том числе по обязательствам перед операторами сотовой связи);
- 7) Количество запросов по кредитной истории;
- 8) Сведения о компаниях, в которых субъект является первым руководителем;
- 9) Сведения из публичных источников;
- 10) Сведения о наличии стоп кредита;
|
Структура стандартного отчета для юридического лиц
В дополнение к данным, содержащимся в первичном отчете, стандартный отчет предоставляет подробную информацию по всем действующим договорам субъекта, а также отказанным и отозванным заявкам.
- 1) Персональные данные с указанием актуальных документов, места регистрации и первых руководителях компании;
- 2) Адресная информация – текущая и историческая;
- 3) Информация о документах – текущая и историческая;
- 4) Сведения о компании;
- 5) Общая информация по обязательствам (блок содержит информацию по количеству контрактов каждого типа, роли субъекта, непогашенной, просроченной сумме и т.д.) (в том числе по обязательствам перед операторами сотовой связи);
- 6) Подробная информация по действующим обязательствам (обязательство, обеспечение по обязательству, дополнительная информация, связанные субъекты, график количества просроченных дней и платежей (дни, сумма в валюте договора), общая информация о просроченной задолженности) (в том числе по обязательствам перед операторами сотовой связи);
- 7) Количество запросов по кредитной истории;
- 8) Сведения из публичных источников;
- 9) Общая информация по наличию задолженности по оплате услуг, предоставляемых Субъектами Естественной Монополии;
|
Структура расширенного отчета для физического лица
В дополнение к данным, содержащимся в стандартном отчете, расширенный отчет предоставляет подробную информацию по всем завершенным договорам субъекта.
- 1) Персональные данные;
- 2) Адресная информация;
- 3) Информация о документах (текущая и историческая);
- 4) Социально-экономический статус для физического лица;
- 5) Общая информация по обязательствам (блок содержит информацию по количеству контрактов каждого типа, роли субъекта, непогашенной, просроченной сумме и т.д.) (в том числе по обязательствам перед операторами сотовой связи);
- 6) Подробная информация по действующим обязательствам (обязательство, обеспечение по обязательству, дополнительная информация, связанные субъекты, график количества просроченных дней и платежей (дни, сумма в валюте договора), общая информация о просроченной задолженности) (в том числе по обязательствам перед операторами сотовой связи);
- 7) Подробная информация по завершенным обязательствам (обязательство, обеспечение по обязательству, дополнительная информация, связанные субъекты, график количества просроченных дней и платежей (дни, сумма в валюте договора), общая информация о просроченной задолженности) (в том числе по обязательствам перед операторами сотовой связи);
- 8) Подробная информация по действующим, отклоненным и отозванным заявкам;
- 9) Количество запросов по кредитной истории (в том числе детализация запросов за 7 дней);
- 10) Сведения о компаниях, в которых субъект является первым руководителем;
- 11) Сведения из публичных источников;
- 12) Сведения о наличии стоп кредита.
|
Структура расширенного отчета для юридического лица
В дополнение к данным, содержащимся в стандартном отчете, расширенный отчет предоставляет подробную информацию по всем завершенным договорам субъекта.
- 1) Персональные данные с указанием актуальных документов, места регистрации и первых руководителях компании;
- 2) Адресная информация – текущая и историческая;
- 3) Информация о документах – текущая и историческая;
- 4) Сведения о компании;
- 5) Общая информация по обязательствам (блок содержит информацию по количеству контрактов каждого типа, роли субъекта, непогашенной, просроченной сумме и т.д.) (в том числе по обязательствам перед операторами сотовой связи);
- 6) Подробная информация по действующим обязательствам (обязательство, обеспечение по обязательству, дополнительная информация, связанные субъекты, график количества просроченных дней и платежей (дни, сумма в валюте договора), общая информация о просроченной задолженности) (в том числе по обязательствам перед операторами сотовой связи);
- 7) Подробная информация по завершенным обязательствам (обязательство, обеспечение по обязательству, дополнительная информация, связанные субъекты, график количества просроченных дней и платежей (дни, сумма в валюте договора), общая информация о просроченной задолженности) (в том числе по обязательствам перед операторами сотовой связи);
- 8) Подробная информация по действующим, отклоненным и отозванным заявкам;
- 9) Количество запросов по кредитной истории;
- 10) Сведения из публичных источников;
|
Структура негативного отчета для физического лица
Негативный отчет содержит сведения о наличии у субъекта кредитной истории просроченной задолженности свыше 90 (девяноста) календарных дней.
- 1) Персональные данные для физического лица;
- 2) Подробная информация о просроченной задолженности свыше 90 календарных дней.
- 3) Сведения о наличии стоп кредита
|
Структура негативного отчета для юридического лица
Негативный отчет содержит сведения о наличии у субъекта кредитной истории просроченной задолженности свыше 90 (девяноста) календарных дней.
- 1) Сведения о компании для юридического лица;
- 2) Подробная информация о просроченной задолженности свыше 90 календарных дней.
|
Структура отчета об отсутствии информации для физического лица
Отчет содержит сведения об отсутствии информации о субъекте кредитной истории.
- 1) Данные, по которым был произведен поиск физического лица;
- 2) Количество запросов по кредитной истории.
- 3) Сведения о наличии стоп кредита
|
Структура отчета об отсутствии информации для юридического лица
Отчет содержит сведения об отсутствии информации о субъекте кредитной истории.
- 1) Данные, по которым был произведен поиск юридического лица;
- 2) Количество запросов по кредитной истории
|
Приложение 1
|
Главная страница | Предыдущая страница |