PAYCIFI API Documentation

Welcome to the PAYCIFI public API documentation. These APIs let you onboard payers and partners, authenticate them with externally owned wallets, interface with already-provisioned programmable wallets, and manage their business profile without relying on the PAYCIFI frontend.

Getting Started

1. Provision or connect a wallet externally – create or attach a wallet using your own custody solution (EOA, your Circle tenant, etc.); PAYCIFI never provisions wallets for you.
2. Authenticate via wallet signature – call GET /auth/nonce then POST /auth/nonce to issue access/refresh tokens for the connected wallet.
3. Complete profile details (optional) – call POST /users/register once you collect the role-specific metadata required for agreements or arbitrators.
4. Use agreement and protocol endpoints – operate the escrow lifecycle with the Agreements REST APIs plus the on-chain DShare contract.
5. Maintain sessions – securely store access/refresh tokens returned by wallet login and refresh them as needed.

Entry Points

• Wallet login – GET /auth/nonce + POST /auth/nonce for signature-based authentication using wallets fully controlled by the integrator.
• Profile completion / Arbitrator activation – POST /users/register with accountType set to arbitrator plus the additional fields listed in the Profile Completion guide.

Integration path

Wallet (externally provisioned)
                      │
                      ▼
      GET /auth/nonce + POST /auth/nonce
                      │
                      ▼
POST /users/register (if profile data required)
                      │
                      ▼
   Ready for PAYCIFI agreement & escrow endpoints

After completing wallet setup, authentication, and any required profile updates, the account is ready to create escrow agreements and operate through the rest of the PAYCIFI platform.

Note: Email/password authentication and delegate wallets are available only through PAYCIFI-managed products and are not part of the public integration surface.