Методы API
Список методов

Получение скоринга

Запрос на формирование скоринга по методу model1

key
Ключ доступа к API
method
Метод запроса (model1 или model2)
lastname
Фамилия по которой запрашивается информация
firstname
Имя по которой запрашивается информация
middlename
Отчество по которой запрашивается информация
birthdate
Дата рождения в формате YYYY-MM-DD
series
Серия паспорта (не обязательно)
number
Номер паспорта (не обязательно)

Результат вызова метода:

Описание возвращаемого JSON

start DateTime
Дата и время создание запроса
end DateTime
Дата и время окончания запроса
method String
Метод по которому формировался запрос
lastname String
Фамилия по которой запрашивается информация
firtsname String
Имя по которой запрашивается информация
middlename String
Отчество по которой запрашивается информация
birthdate String
Дата рождения
series String
Серия паспорта
number String
Номер паспорта
error Boolean
Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
result Object
Объект с результатом возвращаемого запроса
uid Int
Идентификатор возвращаемой задачи

Запрос на формирование скоринга по методу model2

key
Ключ доступа к API
method
Метод запроса (model1 или model2)
lastname
Фамилия по которой запрашивается информация
firstname
Имя по которой запрашивается информация
middlename
Отчество по которой запрашивается информация
phone
Номер телефона, должен начинаться с 7 и иметь 11 символов (не обязательно, если указаны серия и номер паспорта)
series
Серия паспорта, 4 символа (не обязательно, если указан номер телефона)
number
Номер паспорта, 6 символов (не обязательно, если указан номер телефона)

Результат вызова метода:

Описание возвращаемого JSON

start DateTime
Дата и время создание запроса
end DateTime
Дата и время окончания запроса
method String
Метод по которому формировался запрос
lastname String
Фамилия по которой запрашивается информация
firtsname String
Имя по которой запрашивается информация
middlename String
Отчество по которой запрашивается информация
phoneNumber String
Номер телефона
series String
Серия паспорта
number String
Номер паспорта
error Boolean
Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
result Object
Объект с результатом возвращаемого запроса
uid Int
Идентификатор возвращаемой задачи

Результат вызова метода в случае ошибки:

  • Закончился доступ или запросы (Проверить доступ)

  • Нет необходимых прав

  • Некорректный ключ доступа или пользователь не создан

  • Отсутствует Имя

  • Отсутствует фамилия

  • Отсутствует дата рождения или указана в недопустимом формате

  • Отсутствует дата рождения или указана в недопустимом формате

  • Отсутствует номер телефона или серия и номер паспорта

  • Запрос на получение результата задачи по model1 или model2

    key
    Ключ доступа к API
    method
    Метод запроса (report)
    id
    Идентификатор запрашиваемой задачи
    Выполнять запрос на получения результата нужно до тех пор, пока переменная state в объекте result не будет иметь значение 2 или 3

    Результат вызова метода по задаче model1:


    Результат вызова метода по задаче model2:

    Описание возвращаемого JSON

    start DateTime
    Дата и время создание запроса
    end DateTime
    Дата и время окончания запроса
    method String
    Метод по которому формировался запрос
    uid Int
    Идентификатор запрашиваемой задачи
    error Boolean
    Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
    result Object
    Объект с результатом возвращаемого запроса
    id String
    Идентификатор задачи источника
    state Int
    Результат выполнения запроса: 0 - запрос на отчет создан, 1 - запрос на отчет обрабатывается, 2 - запрос на отчет обработан успешно, 3 - запрос на отчет завершился ошибкой
    reportResultType Int
    Результат выполнения запроса: 1 - успешно, 1 - субъект не найден, Null - отчет не готов или ошибка
    report Object
    Объект с результатом возвращаемого запроса
    score Float
    Скоринговый балл
    defaultProbability Float
    Значение вероятности дефолта ФЛ
    scoreTypeName String
    Кодовое название продукта.
    hasStopFactors Boolean
    Субъект имеет стоп-факторы. В таком случаескоринг не может быть рассчитан, т.к. у субъекта имеются текущие долги.

    Результат вызова метода в случае ошибки:

  • Закончился доступ или запросы (Проверить доступ)

  • Нет необходимых прав

  • Некорректный ключ доступа или пользователь не создан

  • Идентификатор задачи не указан
  • Описание возвращаемого JSON

    start DateTime
    Дата и время создание запроса
    end DateTime
    Дата и время окончания запроса
    uid String
    Идентификатор задачи
    error Boolean
    Признак ошибки в запросе, имеет значение true в случае ошибки и null в случае её отсутствия
    error_msg String
    Сообщение с описанием ошибки