Confirmation code

The method returns a confirmation code at the current point (if the code is available).

Request

POST

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

Service URL

Headers

Name

Description

Accept-Language*

Type: string

Preferred response language. Examples: "en" — English

Example: en

Body

application/json
{
    "claim_id": "741cedf82cd464fa6fa16d87155c636"
}

Name

Description

claim_id*

Type: string

Claim ID obtained at the claim creation stage

Example: 741cedf82cd464fa6fa16d87155c636

Min length: 32

Max length: 64

Responses

200 OK

OK

Body

application/json
{
    "code": "2000",
    "attempts": 1
}

Name

Description

attempts*

Type: integer<int64>

Number of remaining code entry attempts (int64)

Example: 1

code*

Type: string

Confirmation code

Example: 2000

404 Not Found

Claim not found or issuing a confirmation code via the API is prohibited.

Body

application/json
{
    "code": "not_found",
    "message": "Claim not found"
}

Name

Description

code*

Type: string

Error code

Example: not_found

Enum: not_found

message*

Type: string

Error description

Example: Claim not found