# Supercosmos for Platforms

## Docs

### Getting Started

- [Introduction to Supercosmos for Platforms: Pix and stablecoins](https://laas.mippo.io/docs/introduction.md): Embed Pix to stablecoin flows in your app with Supercosmos's KYC screening and settlement APIs, built for platforms.
- [Quickstart: your first Pix to stablecoin transaction](https://laas.mippo.io/docs/quickstart.md): Set up API keys, submit KYC for a test client, and process your first Pix to stablecoin transaction with the Supercosmos for Platforms API in under 5 minutes.
- [Authentication with API keys and Clerk JWT](https://laas.mippo.io/docs/authentication.md): How platforms authenticate server calls to the Supercosmos for Platforms API with API keys and how the developer dashboard uses Clerk JWT for user session tokens.

### Guides

- [KYC onboarding models and transaction flows](https://laas.mippo.io/docs/guides/models.md): Compare Supercosmos for Platforms KYC/AML models — Direct Onboard, Client via Platform, and Shared Onboard — with sequence diagrams and Pix settlement flows.
- [Webhooks for transaction and KYC events](https://laas.mippo.io/docs/guides/webhooks.md): Receive real-time notifications for KYC status changes, transaction lifecycle events, and settlement callbacks with signed webhook payloads.
- [Compliance controls in Supercosmos for Platforms](https://laas.mippo.io/docs/guides/compliance.md): How Supercosmos for Platforms handles KYC and KYB, sanctions screening, Travel Rule data, and record retention.

## API Reference

### Overview

- [API overview: base URLs, versioning, and errors](https://laas.mippo.io/docs/api-reference/overview.md): Reference for the Supercosmos for Platforms REST API covering base URLs, versioning, rate limits, request signing, and the shared error response format.

### KYC

- [Submit KYC data for compliance screening](https://laas.mippo.io/docs/api-reference/kyc/submit.md): Send end-user KYC and PEP data to run AML screening and sanctions checks on a client before enabling Pix to stablecoin transactions.
- [Get KYC status for a client onboarding submission](https://laas.mippo.io/docs/api-reference/kyc/status.md): Poll the current state of a KYC submission by kycToken to check whether the client is pending, approved, or rejected by the compliance provider.

### Transactions

- [Initiate a Pix to stablecoin transaction](https://laas.mippo.io/docs/api-reference/transactions/initiate.md): Start a Pix to stablecoin transaction for an approved client by specifying the amount, destination wallet, and target chain and token.
- [Confirm MFA for a pending transaction](https://laas.mippo.io/docs/api-reference/transactions/confirm-mfa.md): Submit the TOTP code from the end-user to clear the multi-factor authentication gate and continue a pending Pix to stablecoin transaction.
- [Get status of a Pix to stablecoin transaction](https://laas.mippo.io/docs/api-reference/transactions/status.md): Poll the current state of a Pix to stablecoin transaction, including Pix receipt, on-chain transfer hash, and pending MFA or compliance gates.

### Access

- [Apply for access to Supercosmos for Platforms](https://laas.mippo.io/docs/api-reference/partner/apply.md): Submit an access application to onboard your company to the Supercosmos for Platforms API, including legal entity details, contact info, and use case.

## SDK

### TypeScript SDK

- [TypeScript SDK for the Supercosmos for Platforms API](https://laas.mippo.io/docs/sdk/typescript.md): Install and use @mippo/laas-sdk, the typed TypeScript client for the Supercosmos for Platforms API covering KYC, transactions, and webhook signature verification.

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Brazilian Portuguese (14 pages)](https://laas.mippo.io/docs/_llms/pt-br.txt): Docs, Referência da API, SDK.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.