KleipData API
Bring intelligence into your applications.
Use KleipData programmatically to search, validate, enrich and connect supported UK intelligence within CRM, casework, internal applications and automated workflows.
Public documentation and customer API access
Public Docs
Available here:
- API overview
- Getting started guidance
- Authentication concepts
- Capability overview
- Integration patterns
- Security guidance
- Developer support
Customer Portal
Sign in for:
- Secret API keys
- Complete API reference
- Supported methods
- Request parameters
- Response schemas
- Examples
- Enabled services
- Usage information
Getting started
From platform access to your first integration.
- 01
Activate KleipData
Your organisation activates KleipData platform and API access.
- 02
Sign in to the Portal
Authorised users access
portal.kleipdata.co.uk. - 03
Create a secret key
Generate a secret API key for the application or workflow being integrated.
kleip_live_sk_••••••••••••7Q2M - 04
Choose a capability
Select the intelligence service required by your workflow.
- 05
Integrate
Use the authenticated API reference to implement the required service.
Authentication
Every KleipData API request requires a secret API key created within the KleipData Portal.
Authorization: Bearer YOUR_SECRET_KEYYour secret key identifies the authorised application and customer organisation making the request.
Create
Generate credentials in the KleipData Portal.
Control
Use separate credentials for individual applications and environments.
Revoke
Rotate or revoke credentials when access requirements change.
Secret keys must be stored securely on the server side.
Never expose KleipData secret keys in:
- browser JavaScript
- public repositories
- client-side configuration
- source code distributed to end users
Request structure
POST https://api.kleipdata.co.uk/v1/[service] Authorization: Bearer YOUR_SECRET_KEYContent-Type: application/jsonRequest example
{
"reference": "CASE-12345",
"input": {
"example": "value"
}
}Response example
{
"requestId": "req_example",
"status": "success",
"data": {}
}API capabilities
One API provides access to multiple supported intelligence domains.
People Intelligence
Search and work with supported information relating to people.
- Person search
- Flexible matching
- Address-linked information
- Person verification
- Supported associations
- Director information
- Record-status information
Address Intelligence
Search and work with supported UK address information.
- Address search
- Occupancy information
- Historical occupancy
- Person/address matching
- UPRN where available
- Geographic information
Company Intelligence
Access supported corporate and commercial information.
- Company search
- Company details
- Directors
- Corporate appointments
- Ownership information
- Company credit information
- Supporting company documents
Property Intelligence
Land Registry includedAccess supported property and registered ownership information.
- Property search
- UPRN
- Title information
- Registered ownership
- Person/property connections
- Company/property connections
Supported England & Wales title and registered ownership searches.
Full reference available in PortalContact Intelligence
Search, validate and enrich supported contact information.
- Telephone search
- Reverse telephone search
- Mobile validation
- Network information
- Contact enrichment
- Email validation where supported
Identity & Screening
Usage-based services may applyUse supported verification and screening services within authorised workflows.
- Identity verification
- KYC
- Supported AML screening
- Data validation
Bulk & Enrichment
Use KleipData with larger operational datasets.
- Matching
- Validation
- Enrichment
- Bulk processing
- Structured results
- Job-based workflows
Location & Geospatial
Use supported location intelligence.
- Geocoding
- Reverse geocoding
- Address geocoding
- Location workflows
Need the complete API reference?
The capabilities and API methods available to your organisation depend on your configured KleipData services. Sign in to access:
- Complete method reference
- Exact parameters
- OpenAPI schemas
- Request examples
- Response examples
- Enabled services
Integration patterns
CRM
Casework
Data Enrichment
Bespoke Application
API access is included
KleipData platform access includes API access so supported intelligence can be used through the KleipData interface or embedded directly into compatible organisational systems.
Platform access
Use KleipData directly.
API access
Use supported intelligence programmatically.
Integration support
Connect compatible CRM, casework and modular systems.
Workflow consultancy
Get implementation support within the agreed deployment scope.
OpenAPI reference
The KleipData API reference uses OpenAPI to provide consistent documentation for supported methods, request structures and responses.
Authenticated customers can use the specification for:
- Interactive reference
- Schema inspection
- Integration development
- API tooling
- Testing
- Client generation where appropriate
Application-specific API keys
Use separate secret keys for individual applications and environments so integrations can be controlled independently.
| Application | Environment | API Key | Status |
|---|---|---|---|
| Housing CRM | Production | kleip_live_sk_••••Q2M | Active |
| Casework Integration | Production | kleip_live_sk_••••8PA | Active |
| CRM Development | Test | kleip_test_sk_••••91C | Active |
Illustrative UI examples. API key management lives in portal.kleipdata.co.uk.
Control what an integration can use
| People | Enabled |
| Addresses | Enabled |
| Companies | Enabled |
| Property | Enabled |
| Contact | Enabled |
| Bulk | Optional |
| KYC / AML | Optional / usage based |
Available capabilities depend on the services enabled for the customer organisation and the permissions assigned to the integration.
KYC & AML through the API
£1.50 per call
Use supported KYC and AML services within onboarding, casework and other authorised workflows.
KYC and AML calls are usage based and sit outside unlimited included intelligence usage.
Screening information supports the customer’s own review process and does not constitute a regulatory determination.
View PricingBulk workflows
Applicable KleipData services support bulk and job-based workflows for larger matching, validation and enrichment requirements.
Available limits and technical requirements are documented in the authenticated API reference.
Understanding search results
Matches
A search may return one or more potential results based on the information supplied and available data.
Context
Results should be interpreted alongside supplied search criteria and available source context.
No Result
The absence of a result does not establish that the underlying person, address, company, property or information does not exist.
Error handling
| Authentication | The supplied credential could not be accepted. |
| Permissions | The requested capability is not enabled. |
| Validation | The supplied request could not be processed. |
| No Result | The request completed without a supported match. |
| Usage | A service-specific usage condition has been reached. |
| Service | The request could not be completed. |
Exact status codes, error identifiers and response schemas are available in the authenticated API reference.
Security & governance
- HTTPS
- Secret-key authentication
- Application-specific credentials
- Credential rotation
- Credential revocation
- Controlled service permissions
- Request identifiers
- Usage visibility
- Audit information where supported
You don’t have to integrate alone.
KleipData platform access includes integration and workflow support within the agreed implementation scope.
Support can include:
- API implementation
- Field mapping
- Response mapping
- CRM integration
- Casework integration
- Workflow design
- Testing
- Bulk workflows