...

Properties of a REST API method document

Purpose

This web service allows to initialize the contract request creation by generating links for the contract_request documents upload.

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Check if token is not expired

  • in case error return 401 - "Token is expired"

Validate user

extract user_id from token

...

• Check if user is active

  • in case error return 403 - (user is not active)

• check legal_entity is active

  • in case error return 403 - (Client is not active)

• Check user role is "OWNER"

  • in case error return 403 "User is not allowed to perform this action"

Validate scopes

• Check user scopes in order to perform this action (scope = 'contract_request:create')

  • Return 403 in case invalid scope(s) "Your scope does not allow to access this resource. Missing allowances: contract_request:create"

Processing

N/A

Response structure examples

Set 

...

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
    "statute_url": "url://upload",
    "additional_document_url": "url://upload"
  }
}

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used

...