API reference

The MicroCrop partner REST API.

The MicroCrop API is REST over HTTPS with JSON request and response bodies.

• Base URL: https://app.microcrop.app/api
• Auth: x-api-key: <your organization API key> — see Authentication
• Envelopes & errors: Errors
• Rate limits: Rate limits

All responses are wrapped in { "success": true, "data": … } (or a paginated variant), and errors in { "success": false, "error": { code, message } }.

The endpoint pages in this section are generated from our OpenAPI specification and include a request playground. Set your x-api-key to try calls against your own organization.

POST /policies/purchase returns 403 until your organization is KYB-verified and holds a current regulator licence, and 400 until MicroCrop has recorded underwriting capacity for it. See Requirements.

Settlement endpoints are gated on the policy’s frozen settlementMode, not on your organization. On a DETERMINATION (Tier 1) policy, POST /payments/initiate and POST /payouts/{payoutId}/retry return 403 TIER_NOT_ENTITLED; conversely POST /determinations/{id}/settlement-report returns 403 NOT_PARTNER_SETTLED on a Tier 2 policy. See Service tiers.