Activate a policy on attested off-platform premium

curl --request PUT \
  --url https://app.microcrop.app/api/policies/{policyId}/activate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "paymentReference": "SFH7TQ2K91",
  "reason": "Premium collected on the Acme till, reconciled 2026-09-01"
}
'

import requests

url = "https://app.microcrop.app/api/policies/{policyId}/activate"

payload = {
    "paymentReference": "SFH7TQ2K91",
    "reason": "Premium collected on the Acme till, reconciled 2026-09-01"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    paymentReference: 'SFH7TQ2K91',
    reason: 'Premium collected on the Acme till, reconciled 2026-09-01'
  })
};

fetch('https://app.microcrop.app/api/policies/{policyId}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.microcrop.app/api/policies/{policyId}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'paymentReference' => 'SFH7TQ2K91',
    'reason' => 'Premium collected on the Acme till, reconciled 2026-09-01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.microcrop.app/api/policies/{policyId}/activate"

	payload := strings.NewReader("{\n  \"paymentReference\": \"SFH7TQ2K91\",\n  \"reason\": \"Premium collected on the Acme till, reconciled 2026-09-01\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.microcrop.app/api/policies/{policyId}/activate")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentReference\": \"SFH7TQ2K91\",\n  \"reason\": \"Premium collected on the Acme till, reconciled 2026-09-01\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/policies/{policyId}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paymentReference\": \"SFH7TQ2K91\",\n  \"reason\": \"Premium collected on the Acme till, reconciled 2026-09-01\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policyNumber": "<string>",
    "status": "PENDING",
    "premiumPaid": true,
    "sumInsured": 123,
    "premium": 123,
    "coverageType": "<string>",
    "onChainPolicyId": "<string>",
    "daysRemaining": 123,
    "payouts": [
      {}
    ],
    "damageAssessments": [
      {}
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Policies

Activate a policy on attested off-platform premium

Attests that premium for a PENDING policy was received OFF-PLATFORM, and flips it to ACTIVE. This is the NORMAL activation path on the DETERMINATION (Tier 1) service tier, where MicroCrop never collects premium; on DETERMINATION_AND_SETTLEMENT it is the reconciliation fallback for premium that did not arrive through the payment provider. It records an audited PREMIUM transaction marked manual:true, providerVerified:false. Requires the policy:activate capability. Refused with 400 if the policy is not PENDING, or if a provider premium payment is still PENDING on it.

PUT

policies

{policyId}

activate

Activate a policy on attested off-platform premium

curl --request PUT \
  --url https://app.microcrop.app/api/policies/{policyId}/activate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "paymentReference": "SFH7TQ2K91",
  "reason": "Premium collected on the Acme till, reconciled 2026-09-01"
}
'

import requests

url = "https://app.microcrop.app/api/policies/{policyId}/activate"

payload = {
    "paymentReference": "SFH7TQ2K91",
    "reason": "Premium collected on the Acme till, reconciled 2026-09-01"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    paymentReference: 'SFH7TQ2K91',
    reason: 'Premium collected on the Acme till, reconciled 2026-09-01'
  })
};

fetch('https://app.microcrop.app/api/policies/{policyId}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.microcrop.app/api/policies/{policyId}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'paymentReference' => 'SFH7TQ2K91',
    'reason' => 'Premium collected on the Acme till, reconciled 2026-09-01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.microcrop.app/api/policies/{policyId}/activate"

	payload := strings.NewReader("{\n  \"paymentReference\": \"SFH7TQ2K91\",\n  \"reason\": \"Premium collected on the Acme till, reconciled 2026-09-01\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.microcrop.app/api/policies/{policyId}/activate")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paymentReference\": \"SFH7TQ2K91\",\n  \"reason\": \"Premium collected on the Acme till, reconciled 2026-09-01\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/policies/{policyId}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paymentReference\": \"SFH7TQ2K91\",\n  \"reason\": \"Premium collected on the Acme till, reconciled 2026-09-01\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policyNumber": "<string>",
    "status": "PENDING",
    "premiumPaid": true,
    "sumInsured": 123,
    "premium": 123,
    "coverageType": "<string>",
    "onChainPolicyId": "<string>",
    "daysRemaining": 123,
    "payouts": [
      {}
    ],
    "damageAssessments": [
      {}
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

policyId

string<uuid>

required

Body

application/json

paymentReference

string

required

Your own evidence that money was received: till number + code, bank reference, receipt id.

Required string length: 3 - 200

Example:

"SFH7TQ2K91"

reason

string

required

Why this is being activated without a provider-verified payment. Recorded for audit.

Required string length: 10 - 500

Example:

"Premium collected on the Acme till, reconciled 2026-09-01"

Response

success

boolean

Example:

true

data

object

Show child attributes

Overview

Endpoints

Activate a policy on attested off-platform premium

Authorizations

Path Parameters

Body

Response