This article answers common questions about the RiskPulse API, including access, credits, available data, monitoring, and integration considerations.
🔑 Getting Access
How do I get access to the RiskPulse API?
RiskPulse API access must be explicitly enabled for your organization. It is not turned on automatically when RiskPulse is enabled.
To request access, contact your Client Success Manager (CSM). Once enabled, you’ll receive API credentials and onboarding documentation.
We already use the RiskPulse portal. Does that include API access?
Not automatically. The RiskPulse portal and the RiskPulse API are enabled separately. Even if your organization uses RiskPulse through the portal, API access must be enabled independently. Your Client Success Manager can confirm your current access status.
💳 Credits & Billing
Which API endpoints consume credits?
Only the View New Profile endpoint consumes credits. This applies when:
A company profile is retrieved for the first time, or
An existing profile is refreshed to retrieve updated data
The following endpoints are always free:
Company Search
View Existing Profile (previously accessed companies)
Monitoring Alerts
How many credits does an API call use?
Credit usage depends on the company’s country of registration:
Europe & North America: 1 credit
All other countries: 3 credits
If a colleague already accessed a company via the portal, will I be charged again via the API?
No. Credits are tracked at the organization level, not per user or channel. If any user or system in your organization has already accessed a company profile, you can retrieve it again using the View Existing Profile endpoint at no additional cost.
What happens if we run out of credits?
To avoid disruption, contact your Account Manager or Client Success Manager before reaching your credit limit.
Can we track how many credits the API has consumed?
Yes.
Credit usage—including API calls—is visible in the Credit Utilization Summary on the RiskPulse landing page. This includes:
Total credits allocated
Credits used
Remaining credits
Any overage credits consumed
📊 Data & Response Format
What format does the API return data in?
All API responses are returned in JSON format.
How do I identify a company when retrieving a profile?
Companies are identified using a CreditSafe Connect ID.
You can obtain a Connect ID by:
Performing a Company Search via the API, or
Looking up the company in the RiskPulse portal
What data is included in a company profile?
A company profile may include (based on country availability):
Company summary and identification details
Common and provider credit scores
Probability of Default (PoD)
Contact information
Standardized and local financial statements
Financial ratios
Share capital and ownership structure
Directors and managers
Group and corporate hierarchy data
Payment data (US only)
Exceptions and risk flags
For a detailed breakdown, see the RiskPulse API Overview article.
Are financial statements available for every company?
No. Financial availability depends on local filing requirements and whether financials have been reported:
Standardized international financials are available where filings exist
Local statutory financials are available for select countries, including the US, UK, France, Norway, Canada, and Sweden
Private companies and companies in lower‑disclosure markets may have limited or no financial data.
Why are some fields missing for certain countries?
Field availability varies based on:
Local legal disclosure requirements
CreditSafe data source coverage by country
How can I confirm which fields are available for a specific country?
Use the Report Schema endpoint:
GET /companies/schema/{countryCode}This endpoint returns the authoritative list of fields that may appear in a company profile for that country.
How current is the data returned by the API?
The API returns the latest available data at the time of the request.
Credit scores are updated whenever new information is received that affects the underlying models—there is no fixed refresh schedule.
To retrieve the most up‑to‑date profile, use the View New Profile endpoint (credit usage applies).
🔔 Monitoring via the API
Can we retrieve monitoring alerts via the API?
Yes. The Monitoring Alerts endpoint allows you to programmatically retrieve alerts for companies on your RiskPulse monitoring list. This endpoint is free and does not consume credits.
Which countries support monitoring alerts?
Monitoring alerts are available for the same eligible countries supported via the RiskPulse portal (47+ countries), including:
United States
United Kingdom
Major European markets
Canada
Japan
South Korea
Companies registered outside the eligible country list will not generate automatic alerts. Contact your Client Success Manager for the full list.
Does the Monitoring Alerts endpoint return full company profiles?
No.
Monitoring Alerts return alert notifications only (for example, a credit score change or director update). To retrieve the full updated report, use the View New Profile endpoint (credit usage applies).
⚙️ Integration & Technical Questions
Is a sandbox or test environment available?
Sandbox and test access may be available depending on your plan. Contact your Client Success Manager for details.
Are there rate limits on API usage?
Rate limits depend on your subscription and use case. Refer to the API Developer Guide or contact your Client Success Manager for details.
Can the API be used to manage RiskPulse monitoring lists?
The API supports profile retrieval and monitoring alert retrieval. For questions about programmatically managing monitored companies, contact your Client Success Manager or refer to the API Developer Guide.