ЕСОЗ - публічна документація

Create Black list user

Owned by Serhii Boldin (SoE eHealth)
Last updated: Feb 25, 2023 by Pavlo Nosenko (UA SoE eHealth)
1 min read

Purpose

This method is used to add tax_id to black list.

Specification

Link

API paragraph not found

Resource

/black_list_users

Scope

bl_user:write

Components

API paragraph not found

Microservices

API paragraph not found

Protocol type

REST

Request type

POST

Sync/Async

Sync

Public/Private/Internal

Internal

 

Logic

This method is used to add tax_id to black list. Fields descriptions are listed in request Example view.

 

Request structure

See on Apiary

Example:

{ "tax_id": "3126509816" }

 

Authorize

Request to process the request using a token in the headers

 

Headers

Наприклад:

  • Content-Type: application/json
    Authorization: Bearer {token}
    api-key: {secret}

 

Request data validation

API paragraph not found

 

Processing

API paragraph not found

 

Response structure

See on Apiary

Example:

{ "meta": { "code": 201, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" }, "data": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "tax_id": "3126509816", "is_active": true, "parties": [ { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "1991-08-19" } ], "inserted_at": "2017-04-20T19:14:13Z", "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e", "updated_at": "2017-04-20T19:14:13Z", "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd" } }

 

Post-processing processes

API paragraph not found

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 201

 

 

ЕСОЗ - публічна документація