Cedar Partners API
  1. Onboarding
Cedar Partners API
  • Introduction
  • Getting Started
    • Data Model
    • Transaction Lifecycle
    • Authentication
    • API Environments
    • Webhooks Configuration
  • Development Tools
    • API Debugging
    • Error Codes
    • File URLs
  • API Documentation
    • Information
      • Get Countries
      • Get Currencies
    • Merchants
      • Create Merchant
      • Update Merchant
      • Get Merchant by ID
      • Get Merchants with Pagination
    • Onboarding
      • Onboarding Lifecycle
      • Get Legal Agreements
        GET
      • Accept Legal Agreements
        POST
      • Submit Merchant Onboarding
        POST
    • Receiver Accounts
      • Create Receiver Account
      • Update Receiver Account
      • Get Receiver Account by ID
      • Get Receiver Accounts with Pagination
    • Transactions
      • Payout (Crypto-to-Fiat)
        • Calculate FX Rate
        • Create Payout Transaction
        • Get Payout Transaction by ID
        • Get Payout Transactions with Pagination
        • Approve Payout Transaction Quote
        • Approve Payout Transaction Deposit
        • Cancel Payout Transaction
      • End to End (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create End to End Transaction
        • Get End to End Transaction by ID
        • Get End to End Transactions with Pagination
        • Approve End to End Transaction Quote
        • Approve End to End Transaction Deposit
        • Cancel End to End Transaction
      • Collections (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create Collections Transaction
        • Get Collections Transaction by ID
        • Get Collections Transactions with Pagination
        • Approve Collections Transaction Quote
        • Approve Collections Transaction Deposit
        • Cancel Collections Transaction
    • Utilities
      • Upload File
  1. Onboarding

Onboarding Lifecycle

The onboarding lifecycle outlines the required steps for successfully onboarding a merchant into the system. Each step can be performed either through the Partners Platform or via the API.

Step 1: Create Merchant#

Merchants represent a business or organization within the system.
API Method: Create Merchant
Partners Platform: Navigate to Merchants > Add New

Step 2: Accept Legal Agreements#

Before proceeding with onboarding, the merchant must accept the Terms of Use and Privacy Policy.
API Methods:
Get Legal Agreements - Get all the legal agreements details including version and URL.
Accept Legal Agreements - Accept all the legal agreements for the merchant.
Partners Platform: Accessible under Merchant Details > Complete Onboarding. Accepting the legal agreements is the first step of the onboarding wizard.

Step 3: Submit Onboarding Form#

Fill in all required onboarding fields and submit the form.
API Method: Submit Merchant Onboarding
Partners Platform: Accessible under Merchant Details > Complete Onboarding.
Once submitted, the merchant’s KYC status transitions to Pending Review.
Note: After submission, onboarding details cannot be updated until the data is reviewed and the status changes.

Onboarding Statuses#

Status NameCodeDescription
PendingPENDINGInitial state. To resubmit the onboarding data, contact support to change the status back to Pending.
Pending ReviewPENDING_REVIEWOnboarding form submitted, awaiting compliance review.
Under ReviewUNDER_REVIEWCompliance team is currently reviewing the onboarding data.
ApprovedVALIDOnboarding approved — the merchant can now transact!
RejectedFLAGGEDOnboarding was rejected due to compliance issues.
Action NeededACTION_NEEDEDAdditional information is required. Must be completed via the partners platform.
Important: When in ACTION_NEEDED status, updates can only be made via the Partners Platform.

Summary#

Each onboarding step is supported via API and Partners Platform.
After submitting onboarding, the data is locked until compliance review.
Status transitions inform you of what action (if any) is needed next.
Reach out to support if you need to reset onboarding to the Pending state.
Modified at 2025-03-24 15:09:43
Previous
Get Merchants with Pagination
Next
Get Legal Agreements
Built with