Getting driver profile (courier)

Request

GET

https://fleet-api.taxi.yandex.net/v2/parks/contractors/driver-profile

Query parameters

Name

Description

contractor_profile_id*

Type: string

Driver's profile ID

Example: 9b17db0cb1f24a38a5c3c8b4f6e4f63b

Headers

Name	Description
X-API-Key*	Type: string API-key Example: `<API key>` Min length: `1`
X-Client-ID*	Type: string Client ID Example: `<Client ID>` Min length: `1`
X-Park-ID*	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4`

Responses

200 OK

Get driver (courier) profile

Body

application/json

{
    "account": {
        "balance_limit": "50",
        "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
        "payment_service_id": "12345",
        "block_orders_on_balance_below_limit": false
    },
    "person": {
        "full_name": {
            "first_name": "Ivan",
            "middle_name": "Ivanovich",
            "last_name": "Ivanov"
        },
        "contact_info": {
            "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63",
            "email": "example-email@example.com",
            "phone": "+79999999999"
        },
        "driver_license": {
            "birth_date": "1975-10-28",
            "country": "rus",
            "expiry_date": "2050-10-28",
            "issue_date": "2020-10-28",
            "number": "070236"
        },
        "driver_license_experience": {
            "total_since_date": "1970-01-01"
        },
        "tax_identification_number": "7743013902",
        "employment_type": "selfemployed"
    },
    "profile": {
        "hire_date": "2020-10-28",
        "work_status": "working",
        "fire_date": "2020-10-28",
        "comment": "great driver",
        "feedback": "great driver"
    },
    "car_id": "5011ade6ba054dfdb7143c8cc9460dbc",
    "order_provider": {
        "platform": false,
        "partner": false
    }
}

Name	Description
account*	Type: AccountOptional Driver's account
order_provider*	Type: OrderProvider
person*	Type: PersonOptional Driver's personal info
profile*	Type: ProfileOptional
car_id	Type: string Vehicle ID Example: `5011ade6ba054dfdb7143c8cc9460dbc` Min length: `1` Max length: `100`

AccountOptional

Driver's account

Name	Description
balance_limit	Type: string Balance limit Example: `50`
block_orders_on_balance_below_limit	Type: boolean Disable all orders if balance is below the limit
payment_service_id	Type: string ID for payments Example: `12345`
work_rule_id	Type: string Work rule ID Example: `bc43tre6ba054dfdb7143ckfgvcby63e`

OrderProvider

Name

Description

partner*

Type: boolean

Are orders from a partner available

platform*

Type: boolean

Are orders from the platform available

PersonOptional

Driver's personal info

Name	Description
contact_info	Type: ContactInfoOptional Driver's contact info
driver_license	Type: DriverLicenseOptional Driver's license info
driver_license_experience	Type: DriverLicenseExperience Driving experience since
employment_type	Type: EmploymentType Driver's employment type. Possible values: `selfemployed` — Self-employed; `park_employee` — Park employee; `individual_entrepreneur` — Individual entrepreneur; Example: `selfemployed` Enum: `selfemployed`, `park_employee`, `individual_entrepreneur`
full_name	Type: FullNameOptional Driver's full name
tax_identification_number	Type: string Tax identification number Example: `7743013902` Min length: `1`

ProfileOptional

Name	Description
comment	Type: string Notes Example: `great driver`
feedback	Type: string Notes (available to park employees) Example: `great driver`
fire_date	Type: string Date of dismissal in ISO 8601 format without time zone Example: `2020-10-28`
hire_date	Type: string Hiring date in ISO 8601 format without time zone Example: `2020-10-28`
work_status	Type: WorkStatus Driver's working status. Possible values: `working` — "Is working" status. `not_working` — "Not working" status; `fired` — status for dismissed drivers; Example: `working` Enum: `working`, `not_working`, `fired`

ContactInfoOptional

Driver's contact info

Name	Description
address	Type: string Address Example: `Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63`
email	Type: string Email Example: `example-email@example.com`
phone	Type: string Phone number Example: `+79999999999` Pattern: `^\+\d{1,15}$`

DriverLicenseOptional

Driver's license info

Name	Description
birth_date	Type: string Birth date in ISO 8601 format without time zone Example: `1975-10-28`
country	Type: string Country of issue (Three-letter code) Example: `rus`
expiry_date	Type: string Driver's license expiry date in ISO 8601 format without time zone Example: `2050-10-28`
issue_date	Type: string Date of issue of the driver's license in ISO 8601 format without time zone Example: `2020-10-28`
number	Type: string Driver's license series and number Example: `070236`

DriverLicenseExperience

Driving experience since

Name

Description

total_since_date*

Type: string

Date without time zone in ISO 8601 format

Example: 1970-01-01

EmploymentType

Driver's employment type. Possible values:

selfemployed — Self-employed;
park_employee — Park employee;
individual_entrepreneur — Individual entrepreneur;

Type

Description

EmploymentType

Example: selfemployed

Enum: selfemployed, park_employee, individual_entrepreneur

FullNameOptional

Driver's full name

Name	Description
first_name	Type: string Name Example: `Ivan`
last_name	Type: string Last name Example: `Ivanov`
middle_name	Type: string Middle name Example: `Ivanovich`

WorkStatus

Driver's working status. Possible values:

working — "Is working" status.
not_working — "Not working" status;
fired — status for dismissed drivers;

Type

Description

WorkStatus

Example: working

Enum: working, not_working, fired

401 Unauthorized

Request authorization parameters are missing

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

403 Forbidden

Insufficient rights to execute the request

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

404 Not Found

Requested resource was not found

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

429 Too Many Requests

Limit of requests was exceeded

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

500 Internal Server Error

Internal server error

Body

application/json

{
    "code": "string",
    "message": "Textual description of the error"
}

Name

Description

message*

Type: string

Human-readable error message

Example: Textual description of the error

code

Type: string

Machine-readable error code

Was the article helpful?

Create contractor profile with indication of partnership type

Driver profile creation