/rusprofile/companies/connections

POST /api/rusprofile/companies/connections

Price: 5 credits

Get the affiliation graph of a Russian company by INN, OGRN or internal id — connected legal entities and individuals (subsidiaries, founders, directors, successors and other relations). Each connection lists the entity id, type (company/person), status, Rusprofile url (and id for the company endpoint) and the relations to the root company with their actuality and start/end dates.

How to use it

Fetch the affiliation/connection graph of a Russian legal entity by INN, OGRN, internal Rusprofile id or company URL. Provide company and count. Each connection has id, aci_id, type (company/person), is_inactive, relation_count (total relations the entity has on Rusprofile), url and links (each with relation, is_actual, started_at and ended_at as unix seconds). This affiliation graph is unique to Rusprofile among the Russian registry sources.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company INN (10 digits), OGRN (13 digits), internal Rusprofile id or a full company URL (examples: "7707083893", "2835629", "https://www.rusprofile.ru/id/2835629"; minLength: 1)
• count integer required — Max number of connected entities to return (min: 1)

Response

• @type string (default: "RusprofileConnection")
• id string nullable
• aci_id string nullable
• type string nullable
• is_inactive boolean nullable
• relation_count integer nullable
• url string nullable
• links array (default: [])
  • @type string (default: "RusprofileConnectionLink")
  • relation string nullable
  • is_actual boolean nullable
  • started_at integer nullable
  • ended_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Company not found (well-formed INN/OGRN but no matching record in the registry) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.