Saol Assurance

AIB life partner platform

API documentation

Reference documentation for public data resources and the proposed AIB life partner sandbox.

Available

Public, read-only resource

Proposed

Non-operational sandbox contract

Current base URL

https://www.saolassurance.ie

Proposed sandbox URL

https://sandbox.api.aiblife.example/v1
Current OpenAPIProposed sandbox OpenAPIAgent tool catalogue

The .example host is intentionally non-routable. Proposed operations below do not accept requests and must not be used for live financial activity.

Endpoints

Policies, applications and servicing

Currently available, unauthenticated machine-readable resources.

GET/data/products.v1.jsonavailable

List public products

Returns the versioned public product directory with stable IDs, summaries and canonical source links.

Operation ID: getPublicProductCatalogue
GET/data/documents.v1.jsonavailable

List public documents

Returns the versioned register of public regulatory, legal and customer-support documents.

Operation ID: getPublicDocumentRegister

Agent integrations

Proposed tool calls

These definitions describe how an approved assistant or workflow engine could call the partner APIs. They are documentation artefacts, not a public MCP server.

search_productsread

Find products using category, need and partner-channel filters.

GET /v1/products
get_product_detailsread

Retrieve factual product details and required documents.

GET /v1/products/{productId}
start_prsa_applicationwrite

Create a draft PRSA application after consent and identity context are established.

POST /v1/prsa/applications
start_policy_applicationwrite

Create a draft application for another enabled policy type.

POST /v1/policy-applications
check_application_statusread

Retrieve progress, outstanding requirements and permitted next actions.

GET /v1/applications/{applicationId}
list_customer_policiessensitive-read

List policies for a strongly authenticated and consented customer.

GET /v1/customers/{customerId}/policies
prepare_policy_top_uppreview

Validate a proposed contribution and return disclosures before confirmation.

POST /v1/policies/{policyId}/top-ups?mode=preview
submit_policy_top_upwrite

Submit a customer-confirmed top-up using a short-lived confirmation token.

POST /v1/policies/{policyId}/top-ups
create_service_requestwrite

Create an auditable policy servicing request for human or automated processing.

POST /v1/policies/{policyId}/service-requests

Security model

Trust is part of the contract

Authentication

OAuth 2.1 client credentials for system access, with customer-bound authorisation for personal policy data and actions.

Consent and confirmation

Explicit scopes, recorded consent and step-up confirmation for applications, servicing changes and contributions.

Auditability

Idempotency keys for writes, correlation IDs, signed webhooks and immutable event trails.

Human oversight

Suitability, advice, exceptions and higher-risk actions remain subject to approved regulatory and human-review controls.