aVenture APIIdentifiers

Deprecated: list the accepted unique identifier types

Deprecated
View as Markdown

Deprecated: use lookup unique-ids types list (GET /v1/lookup/unique-ids/types). Lists the recognized external identifier types (ein, secCik, ticker, lei, duns, isin, cusip, crd, orcid) with each type’s label, accepted aliases, owner scope (entity and/or person), and the format pattern a value must match on write.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
aliaslist of strings
Alias tokens accepted by the write boundary.
canonicalstring

Canonical uniqueId type value persisted in id_type.

labelstring

Human-readable label.

ownerScopelist of enums
Owner kinds this identifier type may attach to.
Allowed values:
patternstring or nullOptional
Regex the identifier value must match, when constrained.

Errors

400
Bad Request Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error