# Leap Financial Documentation

## Docs

- [Check CIP readiness for a link](https://docs.leapfinancial.com/api-reference/partner--cip/check-cip-readiness-for-a-link.md): Checks whether a magic link has enough user data to run CIP (Customer Identification Program) verification. This is a read-only check that does not create tickets or log activity. Use this before calling the create ticket endpoint to ensure all required fields are present.
- [Create a CIP verification ticket](https://docs.leapfinancial.com/api-reference/partner--cip/create-a-cip-verification-ticket.md): Creates a new CIP (Customer Identification Program) verification ticket. Returns a widget URL where the end user can complete identity verification. The link must have sufficient user data (check readiness first) and must not be revoked.
- [Fulfill a user data request](https://docs.leapfinancial.com/api-reference/partner--data-requests/fulfill-a-user-data-request.md): Responds to a `user.data_request` webhook by providing the requested user data. When M2M needs additional user information for CIP verification, it sends a webhook with a data request ID. Use this endpoint to supply the missing data (name, ID, date of birth, payment method, etc.). The data is merged…
- [Create a magic link](https://docs.leapfinancial.com/api-reference/partner--magic-links/create-a-magic-link.md): Creates a new magic link that can be sent to an end user to initiate a money transfer. Optionally pre-fill user data (name, ID, payment method) and configure the link's expiration, flow, theme, and language. Returns the full widget URL and authentication token.
- [Get current partner profile](https://docs.leapfinancial.com/api-reference/partner--magic-links/get-current-partner-profile.md): Returns the authenticated partner's profile including name, status, environment, branding configuration, and operational settings such as allowed payment methods.
- [Get link activity timeline](https://docs.leapfinancial.com/api-reference/partner--magic-links/get-link-activity-timeline.md): Returns the chronological activity timeline for a magic link, including events like link creation, user opening the link, CIP verification steps, and operation lifecycle events.
- [Get magic link details](https://docs.leapfinancial.com/api-reference/partner--magic-links/get-magic-link-details.md): Returns full details of a specific magic link including pre-filled user data (masked), associated user CIP verification status, and operation summary if a transfer was initiated.
- [List magic links](https://docs.leapfinancial.com/api-reference/partner--magic-links/list-magic-links.md): Returns a paginated list of magic links for the authenticated partner. Filter by visibility (active/expired), status, referenceId, and date range.
- [Revoke a magic link](https://docs.leapfinancial.com/api-reference/partner--magic-links/revoke-a-magic-link.md): Revokes an active magic link, preventing the end user from completing the transfer. Only links in "created" or "opened" status can be revoked. Optionally provide a reason.
- [Get operation details](https://docs.leapfinancial.com/api-reference/partner--operations/get-operation-details.md): Returns full details of a specific money transfer operation including amount breakdown, funding and payout method details, status timeline, and failure reason if applicable.
- [List operations](https://docs.leapfinancial.com/api-reference/partner--operations/list-operations.md): Returns a paginated list of money transfer operations for the authenticated partner. Filter by referenceId, userId, linkId, status, and date range. Each operation includes the full amount breakdown (send, receive, rate, fee).
- [Get current partner settings](https://docs.leapfinancial.com/api-reference/partner--settings/get-current-partner-settings.md)
- [Update partner settings](https://docs.leapfinancial.com/api-reference/partner--settings/update-partner-settings.md)
- [Block a user](https://docs.leapfinancial.com/api-reference/partner--users/block-a-user.md): Blocks a user, preventing them from receiving new magic links or completing transfers. Optionally provide a reason for the block. Blocked users can be unblocked later.
- [Get user details](https://docs.leapfinancial.com/api-reference/partner--users/get-user-details.md): Returns full details of a specific user including identity information (masked), CIP verification status, blocked status, and activity statistics (total links, completed operations, last activity).
- [List users](https://docs.leapfinancial.com/api-reference/partner--users/list-users.md): Returns a paginated list of users associated with the authenticated partner. Filter by referenceId, CIP verification status, blocked status, and date range.
- [Unblock a user](https://docs.leapfinancial.com/api-reference/partner--users/unblock-a-user.md): Removes the block from a previously blocked user, allowing them to receive new magic links and complete transfers again.
- [Get webhook configuration](https://docs.leapfinancial.com/api-reference/partner--webhooks/get-webhook-configuration.md): Returns the current webhook configuration for the authenticated partner, including the webhook URL and a masked preview of the secret.
- [Get webhook delivery details](https://docs.leapfinancial.com/api-reference/partner--webhooks/get-webhook-delivery-details.md): Returns full details of a specific webhook delivery attempt including the request payload, response status code, and any error details.
- [List webhook deliveries](https://docs.leapfinancial.com/api-reference/partner--webhooks/list-webhook-deliveries.md): Returns a paginated list of webhook delivery attempts for the authenticated partner. Filter by event type, delivery status, linkId, referenceId, userId, and date range.
- [Regenerate webhook secret](https://docs.leapfinancial.com/api-reference/partner--webhooks/regenerate-webhook-secret.md): Generates a new webhook signing secret. The new secret is returned in the response and will NOT be visible again after this call. Use it to verify webhook signatures (HMAC-SHA256).
- [Update webhook URL](https://docs.leapfinancial.com/api-reference/partner--webhooks/update-webhook-url.md): Updates the webhook URL where M2M will send event notifications (e.g., link.opened, operation.completed, user.data_request). Set to null to disable webhook deliveries.
- [Create a request-money operation](https://docs.leapfinancial.com/api-reference/request-money/create-a-request-money-operation.md)
- [Get the public status of a request by `referenceId`](https://docs.leapfinancial.com/api-reference/request-money/get-the-public-status-of-a-request-by-`referenceid`.md): Returns the stored remittance aggregate or **404** when no snapshot exists.
- [Leapfinancial Documentation](https://docs.leapfinancial.com/index.md): Technical documentation for Leapfinancial products — M2M, RaaS, and VNA
- [Agent orchestration](https://docs.leapfinancial.com/lola/architecture/agent-orchestration.md): How Lola Send routes conversations to specialized agents based on sender identity and compliance status.
- [Celai framework](https://docs.leapfinancial.com/lola/architecture/celai-framework.md): Celai is Leap Financial's proprietary agentic framework that powers Lola Send's message gateway, agent orchestration, and middleware pipeline.
- [Channel integrations](https://docs.leapfinancial.com/lola/architecture/channels.md): How Lola Send connects to messaging platforms through pluggable channel connectors.
- [Message enhancement](https://docs.leapfinancial.com/lola/architecture/message-enhancement.md): How Lola Send transforms AI model responses into structured, channel-optimized messages using Gemini.
- [Middleware pipeline](https://docs.leapfinancial.com/lola/architecture/middleware-pipeline.md): The ordered processing pipeline that authenticates, enriches, and transforms every inbound message before it reaches an agent.
- [RAG capabilities](https://docs.leapfinancial.com/lola/architecture/rag.md): Retrieval-augmented generation for grounding agent responses in approved knowledge bases.
- [State management](https://docs.leapfinancial.com/lola/architecture/state-management.md): Redis-backed session state and conversation history enabling stateless horizontal scaling.
- [Introduction](https://docs.leapfinancial.com/lola/index.md): Lola Send is a conversational AI platform that enables financial institutions to deploy intelligent agents on messaging channels for regulated remittance workflows.
- [Key concepts](https://docs.leapfinancial.com/lola/overview/concepts.md): Core abstractions, terminology, and architectural primitives of the Lola Send platform.
- [Platform overview](https://docs.leapfinancial.com/lola/overview/platform.md): High-level architecture of Lola Send's agentic platform, from message ingestion to response delivery.
- [AI safety and guardrails](https://docs.leapfinancial.com/lola/security/ai-safety.md): How Lola Send defends against prompt injection, jailbreak attacks, and hallucination in a regulated financial context.
- [Security architecture](https://docs.leapfinancial.com/lola/security/architecture.md): Layered security controls protecting every stage of Lola Send's message lifecycle, from ingestion to response delivery.
- [Authentication](https://docs.leapfinancial.com/lola/security/authentication.md): How Lola Send authenticates every sender and secures every session before any agent interaction.
- [Compliance integration](https://docs.leapfinancial.com/lola/security/compliance.md): How Lola Send orchestrates CIP verification, AML screening, and human escalation while the bank's compliance services retain decision authority.
- [Data handling and privacy](https://docs.leapfinancial.com/lola/security/data-handling.md): How Lola Send isolates sensitive data through stateless design, ephemeral storage, and encrypted transport.
- [Data residency and VPC isolation](https://docs.leapfinancial.com/lola/security/data-residency.md): How Lola Send ensures all data stays within controlled infrastructure boundaries, with no unauthorized external data flows.
- [Human-in-the-loop](https://docs.leapfinancial.com/lola/security/human-in-the-loop.md): No financial operation executes without explicit sender approval. Lola Send composes operations and delegates authorization to authenticated web widgets.
- [PCI compliance and card security](https://docs.leapfinancial.com/lola/security/pci-compliance.md): How Lola Send achieves zero card data exposure in the conversational layer through tokenized vaulting and authenticated web widgets.
- [API Overview](https://docs.leapfinancial.com/m2m/api-reference/introduction.md): Base URLs, authentication, response formats, and error handling for the M2M Partner API
- [Authentication](https://docs.leapfinancial.com/m2m/authentication.md): Secure your API requests with API keys and configure webhook verification
- [Introduction](https://docs.leapfinancial.com/m2m/index.md): Enable cross-border payments for your users with M2M's embeddable widget and simple API
- [Data Requests](https://docs.leapfinancial.com/m2m/integration/data-requests.md): Handle webhooks to provide missing user data and reduce friction
- [User Data & Friction](https://docs.leapfinancial.com/m2m/integration/user-data.md): Understand the trade-off between integration effort and user experience
- [User Lifecycle](https://docs.leapfinancial.com/m2m/integration/user-lifecycle.md): How M2M manages users across multiple links and transactions
- [Quick Start](https://docs.leapfinancial.com/m2m/quickstart.md): Create your first magic link and enable cross-border payments in minutes
- [Webhook Events](https://docs.leapfinancial.com/m2m/webhooks/events.md): Reference for all webhook event types and their payloads
- [Webhooks Overview](https://docs.leapfinancial.com/m2m/webhooks/overview.md): Receive real-time notifications about link status and user events
- [Webhook Security](https://docs.leapfinancial.com/m2m/webhooks/security.md): Verify webhook signatures to ensure authenticity and prevent replay attacks
- [Get session link](https://docs.leapfinancial.com/partner-widget-ask/users/get-session-link.md): Orchestrates pre-creation of remote users to instantiate pre-authenticated checkout links for webviews.
- [Get session link (enrolled)](https://docs.leapfinancial.com/partner-widget-ask/users/get-session-link-enrolled.md): Returns the transactional UI link using only the already enrolled and validated UUID (client pre-existing).
- [Register user](https://docs.leapfinancial.com/partner-widget-ask/users/register-user.md): Triggers asynchronous registration for full prospects, enqueueing validation tasks. You can check the status of the registration process by calling the `getUserTokenV2` endpoint.
- [Create contact](https://docs.leapfinancial.com/partner/contacts/create-contact.md): Adds and stores a new contact in the user's address book; prevents duplicate phones.
- [List user contacts](https://docs.leapfinancial.com/partner/contacts/list-user-contacts.md): Retrieves all contacts stored for a user by their ID.
- [Update contact](https://docs.leapfinancial.com/partner/contacts/update-contact.md): Updates and persists attributes of an existing contact for the user.
- [Add UBN account](https://docs.leapfinancial.com/partner/funding/add-ubn-account.md): Adds a UBN account as a new receiving method.
- [Get available receiving methods types](https://docs.leapfinancial.com/partner/funding/get-available-receiving-methods-types.md): Computes available receiving methods types for the corridor.
- [Get receiving method](https://docs.leapfinancial.com/partner/funding/get-receiving-method.md): Retrieves the summary structure for a receiving method by ID.
- [Get receiving methods](https://docs.leapfinancial.com/partner/funding/get-receiving-methods.md): Retrieves the available receiving methods to get money via Request Money.
- [Register card](https://docs.leapfinancial.com/partner/funding/register-card.md): Registers a card as a new receiving method.
- [Get frequent contacts](https://docs.leapfinancial.com/partner/operations/get-frequent-contacts.md): Returns contacts with consolidated interaction data for quick smart suggestions (top N).
- [Get operation detail](https://docs.leapfinancial.com/partner/operations/get-operation-detail.md): Retrieves detailed anatomy, audit pipeline and accounting methods for an correlation ID.
- [Get operation status](https://docs.leapfinancial.com/partner/operations/get-operation-status.md): Retrieves a recent partial snapshot of processing or delivery status for a transaction.
- [List operations (history)](https://docs.leapfinancial.com/partner/operations/list-operations-history.md): Lists transaction history for the given user ID.
- [Request money](https://docs.leapfinancial.com/partner/operations/request-money.md): Creates a request-money event from originator to beneficiary.
- [Request money (atomic flow)](https://docs.leapfinancial.com/partner/operations/request-money-atomic-flow.md): **Request money (atomic / full)**: validates input, ensures a **trusted requester** (`UserServices.ensureTrustedUser`), then enqueues the **RequestMoneyFull** queue job (worker: CIP → contact → payment method → `requestMoneyV2`).
- [Get user profile](https://docs.leapfinancial.com/partner/users/get-user-profile.md): Returns profile and identity-verification status for a registered user identified by phone or email. Loads the user record, subscriber `createdAt`, and CIP process `status` via `cipService.getProcessInfo`.
- [Get user token](https://docs.leapfinancial.com/partner/users/get-user-token.md): Resolves and returns a RaaS user ID from a raw phone number.`
- [Register user](https://docs.leapfinancial.com/partner/users/register-user.md): Triggers asynchronous registration for full prospects, enqueueing validation tasks. You can check the status of the registration process by calling the `getUserTokenV2` endpoint.
- [Introduction](https://docs.leapfinancial.com/raas/api-reference/introduction.md): Explore our API endpoints
- [Partner Webhooks](https://docs.leapfinancial.com/raas/api-reference/partner-webhooks.md): Signature, delivery, and payload reference for operationStatusHook (operation status updates and request-money-full outcomes)
- [Authentication](https://docs.leapfinancial.com/raas/authentication.md): api_key headers, user tokens, typical errors, and safe practices for RaaS Partner API.
- [Request4R (JWE encrypted channel)](https://docs.leapfinancial.com/raas/guides/request4r-jwe.md): Optional Partner API path that wraps JSON in JWE for end-to-end payload confidentiality beyond TLS.
- [Testing & sandbox](https://docs.leapfinancial.com/raas/guides/testing-sandbox.md): Integration test environments, and safe data for Partner API development.
- [RaaS Partner API](https://docs.leapfinancial.com/raas/index.md): Remittance-as-a-service APIs for partners: identity, funding, corridors, and money movement.
- [Quickstart](https://docs.leapfinancial.com/raas/quickstart.md): Call the Partner API with your api_key and obtain a userToken in a few minutes.
- [API reference overview](https://docs.leapfinancial.com/request-api/api-reference/introduction.md): Base URLs, required headers, JSON response patterns, HTTP status codes, and how the OpenAPI spec maps to this API.
- [Authentication](https://docs.leapfinancial.com/request-api/authentication.md): Integrator API keys via X-API-Key on versioned request-money routes, common errors, and secure handling practices.
- [Partner portal API playground](https://docs.leapfinancial.com/request-api/guides/partner-portal-playground.md): Use the Leap partner portal playground to run guided calls with your partner JWT. Create and lookup use your API key; internal status updates use a server-side secret and your signed-in partner account.
- [Request Money API overview](https://docs.leapfinancial.com/request-api/index.md): Create request-money operations, read public status by referenceId, and integrate using the JSON contract and interactive API reference.
- [Quickstart](https://docs.leapfinancial.com/request-api/quickstart.md): Prerequisites, first POST and GET calls to the request-money API, and how to verify responses in minutes.
- [Webhook events catalog](https://docs.leapfinancial.com/request-api/webhooks/events.md): Reference for the operation_created, operation_updated, and operation_error events emitted by the request-money API, including the data payload for each.
- [Webhooks overview](https://docs.leapfinancial.com/request-api/webhooks/overview.md): Receive signed HTTP callbacks for every operation create, update, and error so your systems stay in sync with the request-money API in near real time.
- [General Details](https://docs.leapfinancial.com/vna/client-interfaces/functional-details.md): General Details for VNA Integration
- [Introduction](https://docs.leapfinancial.com/vna/client-interfaces/introduction.md): Client/Partner Interface Implementation Manual
- [Create Account](https://docs.leapfinancial.com/vna/client-interfaces/pmo-create-account.md)
- [Get Create Account URL](https://docs.leapfinancial.com/vna/client-interfaces/pmo-get-create-account-url.md)
- [Tx Authorization](https://docs.leapfinancial.com/vna/client-interfaces/pmo-tx-authorization.md)
- [Credit Funds](https://docs.leapfinancial.com/vna/client-interfaces/vna-credit-funds.md)
- [Get Credit Status](https://docs.leapfinancial.com/vna/client-interfaces/vna-get-credit-status.md)
- [Reverse Credit Funds](https://docs.leapfinancial.com/vna/client-interfaces/vna-reverse-credit-funds.md)

## OpenAPI Specs

- [swagger](https://docs.leapfinancial.com/raas/swagger.json)
- [swagger-partner](https://docs.leapfinancial.com/raas/swagger-partner.json)
- [swagger-partner-widget-ask](https://docs.leapfinancial.com/raas/swagger-partner-widget-ask.json)
- [swagger-partner-send](https://docs.leapfinancial.com/raas/swagger-partner-send.json)
- [swagger-partner-full](https://docs.leapfinancial.com/raas/swagger-partner-full.json)
- [swagger-client-interfaces](https://docs.leapfinancial.com/raas/swagger-client-interfaces.json)
- [openapi](https://docs.leapfinancial.com/request-api/openapi.yaml)
- [swagger-webhooks](https://docs.leapfinancial.com/vna/swagger-webhooks.json)

## Optional

- [Support](mailto:support@leapfinancial.com)