Simulate a KYC outcome (sandbox only)

​

Completes the donor's identity-verification step with the outcome you choose, through the same production webhook path. review and failed let you exercise the donor-facing "in review" and declined screens — not just the happy path. status_code echoes what the webhook edge answered.

Headers
  • Idempotency-Key
    Type: string
    min length:  
    1
    max length:  
    255
    required

    Required on every POST, before any effect. Replays with the same key return the original resource with 200.

Body
required
application/json
  • church_id
    Type: string
    required
  • donor_id
    Type: string
    required
  • outcome
    Type: string enum
    values
    • passed
    • review
    • failed
Responses
  • application/json
  • application/problem+json
  • application/problem+json
Request Example for post/sandbox/simulate/kyc
curl https://api.sandbox.rostergiving.com/sandbox/simulate/kyc \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "donor_id": "",
  "church_id": "",
  "outcome": "passed"
}'

{
  "status_code": 1,
  "simulated": "ACCEPT"
}

Simulated KYC outcome sent to the webhook edge.