Home

Send Request

This quick start guide helps you simulate core compliance operations using the Reap Compliance API’s sandbox environment. We'll walk through 6 key endpoints to help you test entity onboarding, KYC, and feature readiness with confidence.

🧪

Note: This is not an exhaustive guide—the sandbox supports a wide range of endpoints beyond these core flows.


🧠 What You’ll Learn

  • Create an entity (individual or business)
  • Submit requirement values
  • Retrieve an entity and review compliance status
  • Generate an SDK token for KYC verification
  • Verify a signed payload
  • Fetch available features and their requirements

🔐 Authenticate Your API Request

Include your API key in the request headers:

x-reap-api-key: YOUR_API_KEY

🌍 Select an Environment

Always use the sandbox base URL for testing:

https://sandbox-compliance.api.reap.global

Production access is restricted and only available to allowlisted clients.


🧪 Example: Retrieve Features

curl --request GET \
  --url https://sandbox-compliance.api.reap.global/features \
  --header 'Accept-Version: v1.0' \
  --header 'accept: application/json' \
  --header 'x-reap-api-key: YOUR_API_KEY'

🚀 Ready to Try More?

Here are 6 recommended endpoints to begin testing:

ActionMethodEndpoint
Create a new entityPOST/entity
Submit initial requirement valuesPOST/entity (with requirements[])
Retrieve entity statusGET/entity/{entityId}
Generate KYC SDK tokenPOST/entity/{entityId}/kyc
Verify signed KYC payloadPOST/entity/verify-signed-payload
View feature listGET/features

Tip: You can test webhook delivery by configuring notification connections via POST /notification.


Related Materials:

📖 Guide / Getting Started with Sandbox
🔐 API Reference / Authentication ⚙️ API Reference / Entity ⚙️ API Reference / KYC 🔔 API Reference / Notifications