Credas API

Name: Credas API
Brand: Credas API
Availability: InStock

✓ Official Vendor SpecIdentity AuthIdentity VerificationapiKey37 EndpointsREST

For Agents

Run UK identity, KYC, and AML checks by creating registrations, adding ID documents and selfie or liveness images, and pulling back report PDFs and verification status. Use it for property, financial, or legal customer onboarding flows.

Install Jentic One Beta

Connect the Credas API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Credas API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Credas API.

Create a registration record for an individual or company subject and resend the customer invitation when needed

Attach an ID document, selfie, and liveness image to a registration and retrieve those images back per registration

Run a credit-status check that flags bankruptcy, insolvency, CCJs, and active company directorships against a subject

GET STARTED

Start building with Credas API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Credas API for, with concrete tasks.

★ UK customer onboarding with KYC

Onboard a UK customer end to end by creating a registration, capturing or uploading an ID document and a selfie or liveness image, and pulling the completed PDF report once checks have run. The single 'instant' registration endpoint creates the record and attaches an ID document and optional selfie in one call, which is convenient for self-serve flows where the user has already taken a photo.

Call POST /api/registrations/instant with the subject's details, ID document image, and selfie, then poll GET /api/registrations/{id}/summary until checks complete and call GET /api/registrations/{id}/pdf-export.

AML and credit screening for property deals

Screen a buyer or tenant for AML risk by combining a credit-status check that surfaces bankruptcy, insolvency, CCJs and directorships with a property register lookup against the same registration. The agent can then download the settlement-status Share Code PDF when proof of funds is required by the conveyancer.

Call POST /api/credit-status/perform and POST /api/property-register against an existing registrationId, then call GET /api/registrations/{id}/pdf-settlement-status to retrieve the Share Code PDF.

Bank account and company verification

Verify that a sort code and account number belong to the named payer before settling a transaction, and confirm the counterparty company is current at Companies House. The pair of endpoints is useful for finance teams checking supplier details ahead of a first payment without running a full registration.

Call POST /api/bank-accounts/verify with the sort code, account number and account name, then POST /api/companies with the Companies House number to confirm the linked company.

Agent-driven onboarding via Jentic

Let an agent run a Credas onboarding without hard-coding endpoint URLs by routing through Jentic. The agent searches Jentic for an identity verification operation, loads the matching Credas schema, and executes the registration plus document upload steps while Jentic injects the API credential from the vault.

Through Jentic, run search('start a UK identity verification'), load the Credas POST /api/registrations operation, then chain POST /api/images/id-document and GET /api/registrations/{id}/summary.

Key Endpoints

37 endpoints — the credas api powers the identity verification, aml, and onboarding checks used by regulated uk businesses such as estate agents, conveyancers, and lettings firms.

METHOD

PATH

DESCRIPTION

POST

/api/registrations

Create a new registration

POST

/api/registrations/instant

Create a registration with ID document and optional selfie in one call

POST

/api/images/id-document

Add an ID document image to a registration

POST

/api/credit-status/perform

Run credit, bankruptcy, CCJ, and directorship checks

POST

/api/bank-accounts/verify

Verify UK bank account details

POST

/api/companies

Look up a company by Companies House number

GET

/api/registrations/{id}/pdf-export

Download the full PDF report for a registration

POST

/api/web-verifications/by-registrationid

Get a secure web verification link by registration ID

POST

/api/registrations

Create a new registration

POST

/api/registrations/instant

Create a registration with ID document and optional selfie in one call

POST

/api/images/id-document

Add an ID document image to a registration

POST

/api/credit-status/perform

Run credit, bankruptcy, CCJ, and directorship checks

POST

/api/bank-accounts/verify

Verify UK bank account details

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Credas API credentials are stored encrypted in the Jentic vault and applied to https://pi-api.credas.co.uk requests at execution time. The agent never sees the raw key, and it does not appear in prompts, traces, or generated code.

Intent-based discovery

Agents search Jentic with intents like 'start a UK identity verification' or 'run a bankruptcy check' and Jentic returns the matching Credas operation, including the registration and image upload paths, with their input schemas.

Time to first call

Direct integration: 2 to 5 days to wire up registration, image upload, polling, and PDF export logic against the 37 endpoints. Through Jentic: under an hour to discover the right operations, load schemas, and execute a first registration.

FAQs

Specific to using Credas API through Jentic.

What authentication does the Credas API use?

Credas issues per-tenant API credentials that are passed on each call to https://pi-api.credas.co.uk. The OpenAPI spec does not declare a securityScheme block, so refer to your Credas onboarding pack for the exact header name. Through Jentic, the credential is stored encrypted and injected at request time so it never enters the agent's prompt.

Can I run a credit and bankruptcy check with the Credas API?

Yes. POST /api/credit-status/perform against an existing registrationId runs a check that identifies bankruptcy, insolvency, CCJs, and active company directorships for the subject of that registration.

How do I attach an ID document and selfie to a Credas registration?

Create the registration with POST /api/registrations, then call POST /api/images/id-document and POST /api/images/selfie with the registrationId. To do all three in one round trip, use POST /api/registrations/instant which creates the record and attaches an ID document plus optional selfie in a single call.

How do I retrieve a completed Credas report as a PDF?

Call GET /api/registrations/{id}/pdf-export for the full report, GET /api/registrations/{id}/pdf-export-sections for a section-filtered version, or GET /api/registrations/{id}/pdf-settlement-status for the Share Code settlement status PDF.

What are the rate limits for the Credas API?

The published OpenAPI spec does not declare rate limits. Limits are set per Credas contract, so confirm your tenant's quota with your account manager. Build retries around HTTP 429 responses on POST /api/credit-status/perform and the image upload endpoints, which are the heaviest in the API.

How do I start a Credas onboarding flow through Jentic?

Install Jentic with pip install jentic, then async-search for 'start a UK identity verification'. Jentic returns Credas POST /api/registrations and the related image and check operations; load the registration schema, execute it, and chain POST /api/images/id-document. Jentic attaches the Credas credential automatically.

Credas API

Connect the Credas API to your agent

Capabilities

Start building with Credas API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs