{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "affiliation.requirements-changed",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Affiliation requirements changed
Triggered when what the company must prove for an affiliation changed, so the organization can
show the company what to send next. When the change also sends the affiliation back to
WAITING_DOCUMENTS, affiliation.status-changed is sent as well.
This event is sent when:
- Rinne reviewed the provider’s rejection of the attempt:
rejection_reasonson the affiliation lists what was wrong and what to do, the evidence it refused isREJECTED, and the requirements it added arePENDING - That review changed what another open attempt of the organization at the same provider must present (the attempt it held while the review was open, or one that reused the refused evidence or belongs to the same company): that attempt gets its own event
- A biometric verification that was approved had to be captured again, because the provider no
longer serves its selfie: its requirement is
PENDINGagain - Rinne staff added a requirement to the company: it is in
requirements,PENDINGunless evidence the company already sent satisfies it - The provider asked for more documents on an attempt it is analysing: the requirements the request
added are in
requirements, and when it reset or added something the affiliation is back inWAITING_DOCUMENTS
payload.entity is the affiliation as GET /v1/affiliations/{id} answers it at the time of the
event, without company_snapshot.
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "affiliation.requirements-changed",
"version": 1,
"timestamp": "2025-01-15T10:30:00.000Z",
"source": "transaction-service",
"company_id": "comp_123456789",
"correlation_id": "corr_987654321"
}Body
Base structure for all webhook events
Unique event identifier
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Event type identifier
affiliation.requirements-changed "affiliation.requirements-changed"
Event schema version
1
Event timestamp in ISO 8601 format
"2025-01-15T10:30:00.000Z"
Service that generated the event
"transaction-service"
Company ID associated with the event
"comp_123456789"
Shared by every event that one request, inbound webhook or job item caused, so related events can be grouped. Not unique per event: use id to identify and deduplicate an event.
"corr_987654321"
What changed in the affiliation's requirements
Show child attributes
Show child attributes
Response
Webhook received successfully