Simulate a KYC outcome (sandbox only)

Completes the donor's identity-verification step with the outcome you choose, through the same production webhook path. Use it to release a test donor held in review (a test number from +1 202-555-0190 to 0199 always is): passed lets the donor continue in the hosted flow; review and failed keep the donor on the neutral in-review screen, because the hosted flow never tells a donor why, and with failed no account is prepared for the donor. Identify the donor by enrollment_id (from the donor session) or donor_id; one that is not yours, or does not exist, is refused with 400. A donor whose verification already has a final outcome (passed or failed) is not decided again, including one this simulator decided a moment ago whose outcome is still being processed: the request is refused with 400 and nothing is sent, so use a new test donor. 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: 1–255 visible ASCII characters, no spaces. The key belongs to the first body sent with it on this operation for 30 days from the moment that request arrives, including while that request is running and after a 5xx or a timeout. On an operation that creates a resource (POST /v1/churches, POST /v1/churches/import, POST /v1/church_consents, POST /v1/donor_sessions, POST /v1/manage_sessions, POST /v1/refunds and POST /v1/webhook_endpoints), a key whose request succeeded keeps its body for as long as the resource it created exists. A creation replayed with the same key and body returns the original resource with 200 and changes nothing; a 4xx releases the key.

Body

required

application/json

church_id
Type: string
required

Roster identifier of the church this record belongs to.

enrollment_id
Type: string
required

Enrollment of the test donor, from GET /v1/donor_sessions/{id} or enrollment.created. Send this or donor_id.

donor_id
Type: string

Roster identifier of the donor, when you already have it (for example from donation.updated). Send this or enrollment_id.

outcome
Type: "passed" or "review" or "failed"enum

Identity-verification result to simulate. passed lets the donor continue; review and failed both keep the donor on the in-review screen, and with failed no account is prepared. Defaults to passed.

Responses

application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json

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 '{
  "enrollment_id": "",
  "donor_id": "",
  "church_id": "",
  "outcome": "passed"
}'

Show Schema

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

Simulated KYC outcome sent to the webhook edge.

Simulate the bank returning a settled gift days later (sandbox only)

Simulate the donor's bank returning a refund (sandbox only)