Skip to main content

Clients guide

Clients represent the organizations your team evaluates and monitors. Each client record combines identity data, contact details, and finance-specific attributes such as credit limits and credit ratings. Use these endpoints to populate internal dashboards, run screening workflows, or enrich CRM data.

What a client includes​

Client records typically include:

  • Identity - company_name, org_number, country, and core identifiers used across your systems.
  • Credit context - Credit limit and currency fields, plus rating values when available.
  • Contact details - Primary contact name, email, and phone number for operational outreach.
  • Operational metadata - created_at and updated_at timestamps for auditing and sync logic.

List vs. detail endpoints​

  • List clients (GET /api/1.0/clients) returns a paginated collection with essential fields for browsing and search results.
  • Get client (GET /api/1.0/clients/{id}) returns the full profile, including credit metadata and contact information.

Use the list endpoint for index views, and fetch the detail endpoint on demand when a user opens a client profile.

Working with pagination​

List responses include pagination metadata alongside data. Always use limit and page parameters to control payload size. This keeps batch jobs predictable and prevents timeouts when you synchronize a large client portfolio.

Data handling guidance​

  • Sensitive fields - Treat organization numbers and contact information as sensitive data. Mask or hash values before logging.
  • Stable identifiers - Use org_number as a durable key when reconciling client records across systems.
  • Caching - Cache client responses briefly (for example, 5-15 minutes) when building dashboards to reduce API calls.
  • Change detection - Use updated_at to detect changes and reconcile client updates in your database.

Working with the API reference​

The generated API reference in the sidebar documents every request and response schema for client endpoints. Combine the conceptual guidance in this page with those endpoint details to implement integrations that are both intuitive for operators and resilient in production.