Create contractor profile with indication of partnership type

For an individual entrepreneur, the only profession possible is a taxi driver.

Request

POST

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

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-Idempotency-Token*	Type: string Idempotent request token. Must contain only printable ASCII characters Example: `c56fa6537e5a4adbbce6ef3593210fb9` Min length: `16` Max length: `64`
X-Park-ID*	Type: string Partner ID Example: `ee6f33c4562b4e1f8646d157bd70b2c4`

Body

application/json

{
    "contractor": {
        "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"
            },
            "id_doc": {
                "address": "string"
            },
            "tax_identification_number": "7743013902"
        },
        "profile": {
            "hire_date": "2020-10-28",
            "comment": "great driver"
        },
        "car_id": "5011ade6ba054dfdb7143c8cc9460dbc",
        "order_provider": {
            "platform": false,
            "partner": false
        }
    },
    "profession": "taxi/driver",
    "employment": {
        "type": "park_employee"
    }
}

Name	Description
contractor*	Type: ContractorFields Main contractor fields
employment*	Type: ParkEmployee or SelfemployedRus or IndividualEntrepreneurRus or IndividualEntrepreneurKaz Contractor's partnership info
profession*	Type: Profession Contractor's profession. Possible values: `taxi/driver` — Taxi driver; `cargo/courier/on-car` — Driver courier; `cargo/courier/on-truck` — Cargo vehicle driver; Example: `taxi/driver` Enum: `taxi/driver`, `cargo/courier/on-car`, `cargo/courier/on-truck`

ContractorFields

Main contractor fields

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

ParkEmployee

Park employee

Name

Description

type*

Type: string

Enum: park_employee

SelfemployedRus

Self-employed in the Russian Federation

Name

Description

phone*

Type: string

Min length: 1

type*

Type: string

Enum: selfemployed

IndividualEntrepreneurRus

Individual entrepreneur in the Russian Federation

The presence of contractor.person.id_doc.address is also required

Name

Description

tax_system*

Type: TaxSystemRus

Taxation system for IE.

OSN - general taxation system (OSN/OSNO)
USN - simplified taxation system (STS)
AUSN - automated simplified taxation system (AUSN)
OSNP - patent taxation system (OSN)
USNP - patent taxation system (USN)

Enum: OSN, USN, AUSN, OSNP, USNP

type*

Type: string

Enum: individual_entrepreneur

IndividualEntrepreneurKaz

Individual entrepreneur in Kazakhstan

Name	Description
phone*	Type: string Min length: `1`
tax_authority_code*	Type: string Min length: `1`
type*	Type: string Enum: `individual_entrepreneur`

Profession

Contractor's profession. Possible values:

taxi/driver — Taxi driver;
cargo/courier/on-car — Driver courier;
cargo/courier/on-truck — Cargo vehicle driver;

Type

Description

Profession

Example: taxi/driver

Enum: taxi/driver, cargo/courier/on-car, cargo/courier/on-truck

OrderProvider

Name

Description

partner*

Type: boolean

Are orders from a partner available

platform*

Type: boolean

Are orders from the platform available

Person

Driver's personal info

Name	Description
contact_info*	Type: ContactInfo Driver's contact info
driver_license*	Type: DriverLicense Driver's license info
full_name*	Type: FullName Driver's full name
driver_license_experience	Type: DriverLicenseExperience Driving experience since
id_doc	Type: IdDoc Identification document
tax_identification_number	Type: string Tax identification number Example: `7743013902` Min length: `1`

Profile

Name

Description

hire_date*

Type: string

Hiring date in ISO 8601 format without time zone

Example: 2020-10-28

comment

Type: string

Notes

Example: great driver

Account

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
work_rule_id*	Type: string Work rule ID Example: `bc43tre6ba054dfdb7143ckfgvcby63e`
payment_service_id	Type: string ID for payments (generated automatically if missing) Example: `12345`

TaxSystemRus

Taxation system for IE.

OSN - general taxation system (OSN/OSNO)
USN - simplified taxation system (STS)
AUSN - automated simplified taxation system (AUSN)
OSNP - patent taxation system (OSN)
USNP - patent taxation system (USN)

Type	Description
TaxSystemRus	Enum: `OSN`, `USN`, `AUSN`, `OSNP`, `USNP`

ContactInfo

Driver's contact info

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

DriverLicense

Driver's license info

Name	Description
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`
birth_date	Type: string Birth date in ISO 8601 format without time zone Example: `1975-10-28`

FullName

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`

DriverLicenseExperience

Driving experience since

Name

Description

total_since_date*

Type: string

Date without time zone in ISO 8601 format

Example: 1970-01-01

IdDoc

Identification document

Name

Description

address

Type: string

Registration address

Responses

200 OK

Creating a driver profile

Body

application/json

{
    "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}

Name

Description

contractor_profile_id*

Type: string

Driver's profile ID

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

400 Bad Request

Invalid request parameters

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

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

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?

Getting list of driver profiles (couriers)

Getting driver profile (courier)