Создание профиля исполнителя с указанием типа сотрудничества

Для индивидуального предпринимателя возможна только профессия водитель такси.

Request

POST

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

Headers

Name	Description
X-API-Key*	Type: string API-ключ Example: `<API-ключ>` Min length: `1`
X-Client-ID*	Type: string Идентификатор клиента Example: `<Идентификатор клиента>` Min length: `1`
X-Idempotency-Token*	Type: string Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов Example: `c56fa6537e5a4adbbce6ef3593210fb9` Min length: `16` Max length: `64`
X-Park-ID*	Type: string Идентификатор партнера 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 Основные поля исполнителя
employment*	Type: ParkEmployee or SelfemployedRus or IndividualEntrepreneurRus or IndividualEntrepreneurKaz Информация о сотрудничестве исполнителя
profession*	Type: Profession Профессия исполнителя. Допустимые значения: `taxi/driver` — Водитель такси; `cargo/courier/on-car` — Курьер на автомобиле; `cargo/courier/on-truck` — Водитель на грузовом авто; Example: `taxi/driver` Enum: `taxi/driver`, `cargo/courier/on-car`, `cargo/courier/on-truck`

ContractorFields

Основные поля исполнителя

Name	Description
order_provider*	Type: OrderProvider
person*	Type: Person Персональные данные водителя
profile*	Type: Profile
account	Type: Account Учетная запись водителя
car_id	Type: string Идентификатор автомобиля Example: `5011ade6ba054dfdb7143c8cc9460dbc` Min length: `1` Max length: `100`

ParkEmployee

Парковый исполнитель

Name

Description

type*

Type: string

Enum: park_employee

SelfemployedRus

Самозанятый в Российской Федерации

Name

Description

phone*

Type: string

Min length: 1

type*

Type: string

Enum: selfemployed

IndividualEntrepreneurRus

Индивидуальный предприниматель в Российской Федерации

Name

Description

tax_system*

Type: TaxSystemRus

Система налогообложения ИП.

OSN - общая система налогообложения (ОСН/ОСНО)
USN - упрощенная система налогообложения (УСН)
AUSN - автоматизированная упрощенная система налогообложения (АУСН)
OSNP - патентная система налогообложения (ОСН)
USNP - патентная система налогообложения (УСН)

Enum: OSN, USN, AUSN, OSNP, USNP

type*

Type: string

Enum: individual_entrepreneur

IndividualEntrepreneurKaz

Индивидуальный предприниматель в Казахстане

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

Profession

Профессия исполнителя. Допустимые значения:

taxi/driver — Водитель такси;
cargo/courier/on-car — Курьер на автомобиле;
cargo/courier/on-truck — Водитель на грузовом авто;

Type

Description

Profession

Example: taxi/driver

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

OrderProvider

Name

Description

partner*

Type: boolean

Доступны ли заказы от партнера

platform*

Type: boolean

Доступны ли заказы от платформы

Person

Персональные данные водителя

Name	Description
contact_info*	Type: ContactInfo Контактная информация водителя
driver_license*	Type: DriverLicense Информация o водительском удостоверении
full_name*	Type: FullName Полное имя водителя
driver_license_experience	Type: DriverLicenseExperience Водительский стаж c
id_doc	Type: IdDoc Паспортные данные
tax_identification_number	Type: string Идентификационный номер налогоплательщика Example: `7743013902` Min length: `1`

Profile

Name

Description

hire_date*

Type: string

Дата приема в парк в формате ISO 8601 без временной зоны

Example: 2020-10-28

comment

Type: string

Прочее

Example: great driver

Account

Учетная запись водителя

Name	Description
balance_limit*	Type: string Лимит по счету Example: `50`
block_orders_on_balance_below_limit*	Type: boolean Запрещены ли все заказы при балансе ниже лимита
work_rule_id*	Type: string Идентификатор условия работы Example: `bc43tre6ba054dfdb7143ckfgvcby63e`
payment_service_id	Type: string ID для платежа (будет сгенерировано автоматически, если оставить это поле пустым) Example: `12345`

TaxSystemRus

Система налогообложения ИП.

OSN - общая система налогообложения (ОСН/ОСНО)
USN - упрощенная система налогообложения (УСН)
AUSN - автоматизированная упрощенная система налогообложения (АУСН)
OSNP - патентная система налогообложения (ОСН)
USNP - патентная система налогообложения (УСН)

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

ContactInfo

Контактная информация водителя

Name	Description
phone*	Type: string Номер телефона Example: `+79999999999` Pattern: `^\+\d{1,15}$`
address	Type: string Адрес Example: `Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63`
email	Type: string Электронная почта Example: `example-email@example.com`

DriverLicense

Информация o водительском удостоверении

Name	Description
country*	Type: string Страна выдачи водительского удостоверения (Трехбуквенный код) Example: `rus`
expiry_date*	Type: string Дата окончания действия водительского удостоверения в формате ISO 8601 без временной зоны Example: `2050-10-28`
issue_date*	Type: string Дата выдачи водительского удостоверения в формате ISO 8601 без временной зоны Example: `2020-10-28`
number*	Type: string Серия и номер водительского удостоверения Example: `070236`
birth_date	Type: string Дата рождения в формате ISO 8601 без временной зоны Example: `1975-10-28`

FullName

Полное имя водителя

Name	Description
first_name*	Type: string Имя Example: `Ivan`
last_name*	Type: string Фамилия Example: `Ivanov`
middle_name	Type: string Отчество Example: `Ivanovich`

DriverLicenseExperience

Водительский стаж c

Name

Description

total_since_date*

Type: string

Дата в формате ISO 8601 без временной зоны

Example: 1970-01-01

IdDoc

Паспортные данные

Name

Description

address

Type: string

Адрес регистрации

Responses

200 OK

Создание профиля водителя

Body

application/json

{
    "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}

Name

Description

contractor_profile_id*

Type: string

Идентификатор профиля водителя

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

400 Bad Request

Некорректные параметры запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json

{
    "code": "string",
    "message": "Текстовое описание ошибки"
}

Name

Description

message*

Type: string

Человекочитаемое сообщение об ошибке

Example: Текстовое описание ошибки

code

Type: string

Машиночитаемый код ошибки

Была ли статья полезна?

Получение списка профилей водителей (курьеров)

Получение профиля водителя (курьера)