6.1. Get confirmation code

  1. HTTP Request
  2. Header Parameters
  3. Request Body
    1. Representation
    2. Fields
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 404
      1. Representation
      2. Fields
  5. Example

Returns the confirmation code at the current point (if possible)

HTTP Request

POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/confirmation_code

Header Parameters

Accept-Language *

string

Preferred language of response. Examples: "ru" — Russian, "en" — English

Accept-Language *

string

Preferred language of response. Examples: "ru" — Russian, "en" — English

Request Body

{
  "claim_id": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

claim_id *

string

Claim ID, received upon creation of claim

claim_id *

string

Claim ID, received upon creation of claim

Responses

Code 200

OK

{
  "attempts": integer,
  "code": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

attempts *

integer

Number of remaining attempts to enter code (int64)

code *

string

Confirmation code

attempts *

integer

Number of remaining attempts to enter code (int64)

code *

string

Confirmation code

Code 404

Claim not found or confirmation code issuance via API prohibited.

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

Example

Request:

curl -X POST "b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/confirmation_code" \
-H "Accept-Language: {string}" \
-d '{
  "claim_id": "741cedf82cd464fa6fa16d87155c636"
}'
Copied to clipboard

Responses:

{
  "attempts": 1,
  "code": "2000"
}
Copied to clipboard