POSTlive

Authorize one case-specific filing sponsorship referral

Requires the sponsorships:authorize capability on an explicitly provisioned platform_orchestrator credential. The server derives the sponsor, active agreement, $5 filing assessment, and environment; callers cannot select price or commercial terms. Authorization alone does not docket a case or accrue an obligation. Compatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.

/api/v2/sponsorship-referralsauthorizeCaseSponsorshipReferralV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

Parameters

Name	Location	Requirement	Schema
`Idempotency-Key`	header	Required	`{"type":"string","minLength":8,"maxLength":200}`

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/CaseSponsorshipReferralInput",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "externalCaseId",
    "externalTransactionId",
    "intendedParties",
    "feeType"
  ],
  "properties": {
    "externalCaseId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "externalTransactionId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "intendedParties": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "claimantExternalId",
        "respondentExternalId"
      ],
      "properties": {
        "claimantExternalId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "respondentExternalId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        }
      }
    },
    "feeType": {
      "type": "string",
      "const": "filing"
    }
  }
}

Responses

200

An identical coverage authorization already exists.

application/json

{
  "$ref": "#/components/schemas/CaseSponsorshipReferralEnvelope",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CaseSponsorshipReferral",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "referralAuthorizationId",
        "externalCaseId",
        "externalTransactionId",
        "feeType",
        "status",
        "expiresAt"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "case-referral-authorization-v1"
        },
        "referralAuthorizationId": {
          "type": "string"
        },
        "externalCaseId": {
          "type": "string"
        },
        "externalTransactionId": {
          "type": "string"
        },
        "feeType": {
          "type": "string",
          "const": "filing"
        },
        "status": {
          "type": "string",
          "const": "accepted"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}

201

Case-specific referral accepted.

application/json

{
  "$ref": "#/components/schemas/CaseSponsorshipReferralEnvelope",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CaseSponsorshipReferral",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "referralAuthorizationId",
        "externalCaseId",
        "externalTransactionId",
        "feeType",
        "status",
        "expiresAt"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "case-referral-authorization-v1"
        },
        "referralAuthorizationId": {
          "type": "string"
        },
        "externalCaseId": {
          "type": "string"
        },
        "externalTransactionId": {
          "type": "string"
        },
        "feeType": {
          "type": "string",
          "const": "filing"
        },
        "status": {
          "type": "string",
          "const": "accepted"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}

default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "case-referral-authorization-v1",
    "referralAuthorizationId": "referralAuthorizationId_test",
    "externalCaseId": "marketplace_case_123",
    "externalTransactionId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "feeType": "filing",
    "status": "accepted",
    "expiresAt": "2026-08-09T12:00:00.000Z"
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

For throttling, honor Retry-After when present. Back off on retryable server failures.
Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.

Use https://peoplescourt.ai with the test credential issued for your integration.

cURL

curl --request POST \
  --url 'https://peoplescourt.ai/api/v2/sponsorship-referrals' \
  --header 'Authorization: Bearer pk_test_replace_me' \
  --header 'Idempotency-Key: idem_test_12345678' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalCaseId": "marketplace_case_123",
  "externalTransactionId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "intendedParties": {
    "claimantExternalId": "Test-environment procedural message.",
    "respondentExternalId": "Test-environment procedural message."
  },
  "feeType": "filing"
}'

TypeScript / fetch

const response = await fetch("https://peoplescourt.ai/api/v2/sponsorship-referrals", {
  method: "POST",
  headers: {
    "Authorization": "Bearer pk_test_replace_me",
    "Idempotency-Key": "idem_test_12345678",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "externalCaseId": "marketplace_case_123",
    "externalTransactionId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "intendedParties": {
      "claimantExternalId": "Test-environment procedural message.",
      "respondentExternalId": "Test-environment procedural message."
    },
    "feeType": "filing"
  }),
});
if (!response.ok) throw await response.json();
const result = await response.json();

Python

import requests

response = requests.post(
    "https://peoplescourt.ai/api/v2/sponsorship-referrals",
    headers={
      "Authorization": "Bearer pk_test_replace_me",
      "Idempotency-Key": "idem_test_12345678",
      "Content-Type": "application/json"
    },
    json={"externalCaseId": "marketplace_case_123", "externalTransactionId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "intendedParties": {"claimantExternalId": "Test-environment procedural message.", "respondentExternalId": "Test-environment procedural message."}, "feeType": "filing"},
    timeout=30,
)
response.raise_for_status()
result = response.json()