Работа с черными списками

Черные списки BAF - это механизм контроля доступа к ресурсам заказчика исключительно для верифицированных пользователей.

Управление черными списками включает возможность получения информации о пользователе, а также редактирования и удаления данных пользователя.

Добавление персоны в черный список

Эндпоинт POST /api​/v2​/private​/Blacklist

Пример запроса:

{
  "firstName": "Bob",
  "middleName": "Jamesbob",
  "familyName": "Familybob",
  "dob": "2023-06-22T13:57:35.163Z"
}

Пример ответа:

Status Code

200

{
    "data": "e8f42***", // personId
    "succeeded": true,
    "isError": false,
    "errors": []
}

После добавления в черный список пользователю с такими данными будет отказано в доступе.

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

Чтобы получить актуальный черный список пользователей, необходимо отправить запрос на эндпоинт с возможностью фильтрации.

Эндпоинт GET ​/api​/v2​/private/Blacklist

Название поля	Описание	Значение
Page	Номер страницы	От 1 до 2147483647
PageSize	Максимальное количество аппликантов на странице	От 1 до 400

Для поиска и сортировки можно использовать следующие поля:

Название поля	Описание
SortField	Поле для сортировки. Можно указать firstName, lastName, phone и т.д.
Order	Порядок сортировки для выбранного поля. Для порядка по убыванию укажите значение: descending. Порядок по возрастанию задан по умолчанию.
TextFilter	Текстовый поиск

Пример запроса:

curl -X 'GET' \
  'https://baf.3divi.ai/publicapi/api/v2/private/Blacklist?Page=1&PageSize=10' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer sk_3938***'

Пример ответа:

Status Code

200

{
    "data": {
        "page": 1,
        "pageSize": 10,
        "total": 1,
        "totalPages": 1,
        "items": [
            {
                "id": "e8f4***",
                "firstName": "BOB",
                "middleName": "JAMESBOB",
                "familyName": "FAMILYBOB",
                "dob": "2023-06-22T13:57:35.163"
            }
        ]
    },
    "succeeded": true,
    "isError": false,
    "errors": []
}

Добавление аппликанта в черный список

Эндпоинт POST ​/api​/v2​/private/Blacklist/FromApplicantId

Тело запроса:

{
  "applicantId": "string"
}

Пример запроса:

curl -X 'POST' \
  'https://baf.3divi.ai/publicapi/api/v2/private/Blacklist/FromApplicantId' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer sk_3938***' \
  -H 'Content-Type: application/json' \
  -d '{
  "applicantId": "9687***"
}'

Пример ответа:

Status Code

200

3fa85*** // personId

Получение информации о персоне из черного списка

Эндпоинт GET ​/api​/v2​/private/Blacklist/{personId}

Параметры:

personId - ID персоны

Пример запроса:

curl -X 'GET' \
  'https://baf.3divi.ai/publicapi/api/v2/private/Blacklist/3fa85***' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer sk_3938***'

Пример ответа:

Status Code

200

{
  "id": "3fa85***",
  "applicantId": "3fa85f6***",
  "firstName": "string",
  "middleName": "string",
  "familyName": "string",
  "dob": "2023-09-21T16:40:58.882Z"
}

Изменение информации о персоне из черного списка

Эндпоинт PUT ​/api​/v2​/private/Blacklist/{personId}

Параметры:

personId - ID персоны

Тело запроса:

{
  "firstName": "string",
  "middleName": "string",
  "familyName": "string",
  "dob": "2023-09-21T16:44:32.658Z"
}

Пример запроса:

curl -X 'PUT' \
  'https://baf.3divi.ai/publicapi/api/v2/private/Blacklist/9687***' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer sk_3938***' \
  -H 'Content-Type: application/json' \
  -d '{
  "firstName": "string",
  "middleName": "string",
  "familyName": "string",
  "dob": "2023-09-21T16:44:32.658Z"
}'

Пример ответа:

Status Code

200

Возможные ошибки:

Status Code

404

{
  "code": "NotFound",
  "message": "BlacklistPerson with id 96875*** not found",
  "additionalData": null,
  "propertyErrors": null,
  "multipleErrors": null,
  "traceId": "00-dc0c89f31b004db6869f865eb8137ef8-2104851f76822ded-00"
}

Удаление персоны из черного списка

Эндпоинт DELETE ​/api​/v2​/private/Blacklist/{personId}

Параметры:

personId - ID персоны

Пример запроса:

curl -X 'DELETE' \
  'https://baf.3divi.ai/publicapi/api/v2/private/Blacklist/9687***' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer sk_3938***'

Пример ответа:

Status Code

200

Возможные ошибки:

Status Code

404

{
  "code": "NotFound",
  "message": "BlacklistPerson with id 96875*** not found",
  "additionalData": null,
  "propertyErrors": null,
  "multipleErrors": null,
  "traceId": "00-dc0c89f31b004db6869f865eb8137ef8-2104851f76822ded-00"
}