Skip to main content
POST
companies.credit-history.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
registryNumber
string
required

Official registry number.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9 ._-]*$
jurisdiction
string
required

Register jurisdiction, such as gb or in.

Required string length: 1 - 16
Pattern: ^[a-z]{2}(_[a-z0-9]{2,3})?$

Response

The result

ratings
object[]
required

Business credit ratings.

Maximum array length: 100
defaults
object[]
required

Disclosed company default facts.

Maximum array length: 100