Skip to content

Select theme

Overview
Get started
Concepts
Integrate
SDKs and rails
API reference
- API reference
- Endpoints
  - Overview
  - Meta
    
    Health check GET
    Who is calling GET
    Public JWKS of pack signing keys GET
  - Sources
    
    List registered sources GET
    Register a source POST
  - API keys
    
    List API keys GET
    Create an API key POST
    Revoke an API key DELETE
  - Events
    
    List events GET
    Send signed events POST
    Check events without storing them POST
    Get one event GET
  - Packs
    
    View a shared evidence pack GET
    List evidence packs GET
    Build a case evidence pack POST
    Create a due-diligence report POST
    Create a pack share link POST
    Revoke a share link DELETE
  - Mandates
    
    Get one mandate GET
  - Metrics
    
    Overview metrics GET
  - Agents
    
    List agents GET
    Get one agent GET
    Label an agent PATCH
  - Owners
    
    List owners GET
    Get one owner GET
  - Payees
    
    List payees GET
    Get one payee GET
  - Alerts
    
    List alerts GET
    Get one alert GET
    Act on an alert POST
  - Screening
    
    List screenings GET
    Review a screening POST
    Ad-hoc payee screening POST
  - Cases
    
    List cases GET
    Create a case POST
    Get a case GET
    Add an item to a case POST
    Remove an item from a case DELETE
    Add a case note POST
    Update case status POST
Monitor and review
Reference
Trust and security

Select theme

On this page

Overview
Responses
- 200
- 503

On this page

Overview
Responses
- 200
- 503

Health check

GET

/healthz

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Healthy

Select media type

object

ok

required

boolean

db

required

string

503

Section titled “503 ”

The database is unreachable

Select media type

object

ok

required

boolean

db

required

string