VK ADO

Eng

Рус
中國人

Eng

Рус
中國人

Appearance

Persons API ​

About a person.

The person features:

  • The same person can have different roles.
  • Different types of persons have different details.

Note

For an individual also acting as an individual entrepreneur, you must create two persons with the same TIN.

Person with my external ID ​

This represents your own person.

Create person ​

swagger

http
PUT /v1/person/{external_id}

Request example of individual creation ​

http
PUT https://api-sandbox.ord.vk.com/v1/person/rajs3fu1698-1h5a50m5u HTTP/1.1
Host: api-sandbox.ord.vk.com
Authorization: Bearer 948d799671533a2eb98e575aa96718e6
Content-Type: application/json

{
  "name": "Sergey Ivanov",
  "roles": [
    "advertiser",
    "agency"
  ],
  "juridical_details": {
    "type": "physical",
    "inn": "727718317746",
    "phone": "+7(495)709-56-39"
  }
}
shell
curl -i -XPUT 'https://api-sandbox.ord.vk.com/v1/person/rajs3fu1698-1h5a50m5u' \
  -H 'Authorization: Bearer 948d799671533a2eb98e575aa96718e6' \
  -H 'Content-type: application/json' \
  --data '{
  "name": "Sergey Ivanov",
  "roles": [
    "advertiser",
    "agency"
  ],
  "juridical_details": {
    "type": "physical",
    "inn": "727718317746",
    "phone": "+7(495)709-56-39"
  }
}'
http
PUT https://api-sandbox.ord.vk.com/v1/person/hmcemd974pu-6qpjep9ys HTTP/1.1
Host: api-sandbox.ord.vk.com
Authorization: Bearer 948d799671533a2eb98e575aa96718e6
Content-Type: application/json

{
  "name": "Tasty Desserts LLC",
  "rs_url": "https://example.com",
  "roles": [
    "ors"
  ],
  "juridical_details": {
    "type": "juridical",
    "inn": "1517905992",
    "phone": "+7(495)391-76-44"
  }
}
shell
curl -i -XPUT 'https://api-sandbox.ord.vk.com/v1/person/hmcemd974pu-6qpjep9ys' \
  -H 'Authorization: Bearer 948d799671533a2eb98e575aa96718e6' \
  -H 'Content-type: application/json' \
  --data '{
  "name": "Tasty Desserts LLC",
  "rs_url": "https://example.com",
  "roles": [
    "ors"
  ],
  "juridical_details": {
    "type": "juridical",
    "inn": "1517905992",
    "phone": "+7(495)391-76-44"
  }
}'

Request example of individual entrepreneur creation ​

http
PUT https://api-sandbox.ord.vk.com/v1/person/8yjfa2yw4zm-arzxqw9ww HTTP/1.1
Host: api-sandbox.ord.vk.com
Authorization: Bearer 948d799671533a2eb98e575aa96718e6
Content-Type: application/json

{
  "name": "Ivan Maksimov",
  "rs_url": "https://example.com",
  "roles": [
    "publisher"
  ],
  "juridical_details": {
    "type": "ip",
    "inn": "025532517930",
    "phone": "+7(495)640-29-09"
  }
}
shell
curl -i -XPUT 'https://api-sandbox.ord.vk.com/v1/person/8yjfa2yw4zm-arzxqw9ww' \
  -H 'Authorization: Bearer 948d799671533a2eb98e575aa96718e6' \
  -H 'Content-type: application/json' \
  --data '{
  "name": "Ivan Maksimov",
  "rs_url": "https://example.com",
  "roles": [
    "publisher"
  ],
  "juridical_details": {
    "type": "ip",
    "inn": "025532517930",
    "phone": "+7(495)640-29-09"
  }
}'

Request example of foreign individual creation ​

http
PUT https://api-sandbox.ord.vk.com/v1/person/9jyu3m5wkfs-xxwgc67b2 HTTP/1.1
Host: api-sandbox.ord.vk.com
Authorization: Bearer 948d799671533a2eb98e575aa96718e6
Content-Type: application/json

{
  "name": "Andreas Georgiou",
  "rs_url": "https://example.com",
  "roles": [
    "ors"
  ],
  "juridical_details": {
    "type": "foreign_physical",
    "phone": "+357-10-284-521",
    "foreign_epayment_method": "4000123456789010",
    "foreign_inn": "92610973L",
    "foreign_oksm_country_code": "196"
  }
}
shell
curl -i -XPUT 'https://api-sandbox.ord.vk.com/v1/person/9jyu3m5wkfs-xxwgc67b2' \
  -H 'Authorization: Bearer 948d799671533a2eb98e575aa96718e6' \
  -H 'Content-type: application/json' \
  --data '{
  "name": "Andreas Georgiou",
  "rs_url": "https://example.com",
  "roles": [
    "ors"
  ],
  "juridical_details": {
    "type": "foreign_physical",
    "phone": "+357-10-284-521",
    "foreign_epayment_method": "4000123456789010",
    "foreign_inn": "92610973L",
    "foreign_oksm_country_code": "196"
  }
}'
http
PUT https://api-sandbox.ord.vk.com/v1/person/879at3kr72z-6d7wqh9wb HTTP/1.1
Host: api-sandbox.ord.vk.com
Authorization: Bearer 948d799671533a2eb98e575aa96718e6
Content-Type: application/json

{
  "name": "BelFood",
  "roles": [
    "agency"
  ],
  "juridical_details": {
    "type": "foreign_juridical",
    "phone": "+375-17-327-45-62",
    "foreign_epayment_method": "4010123456789030",
    "foreign_registration_number": "623456785",
    "foreign_oksm_country_code": "112"
  }
}
shell
curl -i -XPUT 'https://api-sandbox.ord.vk.com/v1/person/879at3kr72z-6d7wqh9wb' \
  -H 'Authorization: Bearer 948d799671533a2eb98e575aa96718e6' \
  -H 'Content-type: application/json' \
  --data '{
  "name": "BelFood",
  "roles": [
    "agency"
  ],
  "juridical_details": {
    "type": "foreign_juridical",
    "phone": "+375-17-327-45-62",
    "foreign_epayment_method": "4010123456789030",
    "foreign_registration_number": "623456785",
    "foreign_oksm_country_code": "112"
  }
}'

Response example ​

http
HTTP/1.1 201 Created

Get person ​

swagger

http
GET /v1/person/{external_id}

Request example ​

http
GET https://api-sandbox.ord.vk.com/v1/person/879at3kr72z-6d7wqh9wb HTTP/1.1
Host: api-sandbox.ord.vk.com
Authorization: Bearer 948d799671533a2eb98e575aa96718e6
shell
curl -i -XGET 'https://api-sandbox.ord.vk.com/v1/person/879at3kr72z-6d7wqh9wb' \
  -H 'Authorization: Bearer 948d799671533a2eb98e575aa96718e6'

Response example ​

http
HTTP/1.1 200 OK
Content-Type: application/json

{
  "create_date": "2023-08-01T14:11:51Z",
  "name": "BelFood",
  "roles": [
    "agency"
  ],
  "juridical_details": {
    "type": "foreign_juridical",
    "phone": "+375173274562",
    "foreign_epayment_method": "4010123456789030",
    "foreign_registration_number": "623456785",
    "foreign_oksm_country_code": "112"
  }
}

Get person list ​

swagger

http
GET /v1/person

Request example ​

http
GET https://api-sandbox.ord.vk.com/v1/person?limit=5 HTTP/1.1
Host: api-sandbox.ord.vk.com
Authorization: Bearer 948d799671533a2eb98e575aa96718e6
shell
curl -i -XGET 'https://api-sandbox.ord.vk.com/v1/person?limit=5' \
  -H 'Authorization: Bearer 948d799671533a2eb98e575aa96718e6'

Response example ​

http
HTTP/1.1 200 OK
Content-Type: application/json

{
  "external_ids": [
    "my",
    "05bhuvr1rr8-1h3es50st",
    "uphvmeo04lo-1h4iv1hdd",
    "uec04hll3pg-1h5a4mig2",
    "rajs3fu1698-1h5a50m5u"
  ],
  "total_items_count": 13,
  "limit": 5
}