Agreement

Rulebook for a sharing relationship

It defines what is shared, which customers qualify, when sharing is allowed and what can be requested later.

The Recipient creates and sends the agreement. The Donor reviews the agreement section by section and accepts or declines each section. The Donor cannot edit the Recipient's proposal directly; if a section is
declined, the Recipient updates the agreement and sends a new version.

What's included in an agreement?

SectionWhat it definesDonor review
SetupRecord type, start date, and end dateRequired
EligibilityCustomer qualification rules, maximum verification age (staleness), required inputs, trust level, and consent requirementRequired
RFI catalogQuestions and documents the Recipient may request later, including the recency threshold for reusing an existing answerRequired
Recipient Configuration Import mode (automated or manual), Template settings, Webhook configurationsPrivate to Recipient

Example agreement

A payout provider wants to receive KYB business profiles from a payment platform.

  • Record type: Business profiles.
  • Eligibility: Businesses registered in Indonesia.
  • Verification recency: Approved within the last 12 months.
  • Trust level: No Reliance.
  • Required inputs: All fields required by the payout provider's KYB template.
  • RFI catalog: Proof of address and source of funds, with an agreed 90-day reuse threshold.
  • Import mode: Automatic.
  • Recipient template: The payout provider's own KYB template.

The Donor reviews the Setup, Eligibility and RFI catalog sections. Once all required sections are accepted and the start date is reached, the agreement becomes live.

Agreement states

StateNew tokensExisting tokens and follow-ups
PendingNo tokens, agreement not accepted by both the partners-
ApprovedNo tokens are shared until the agreement's start date.Not applicable until tokens exist.
LiveQualifying customers can be shared.Existing tokens and follow-ups continue.
PausedNo new customers are shared. Customers approved while the agreement is paused are skipped and are not shared later.Existing tokens and follow-ups continue.
TerminatedNo new customers are shared.Follow-up requests are revoked. Tokens already waiting in the import queue can still be imported.

Versions and priority

  • Version history: Every agreement version is retained.
  • Token traceability: Each token records the agreement version under which it was created.
  • Changes to live agreements: If a live agreement is edited, sharing pauses until the Donor accepts the updated version.
  • Multiple agreements: A Recipient can have multiple agreements with the same Donor.
  • Agreement selection: If a customer qualifies under multiple agreements for the same connection, the Recipient's highest-priority matching agreement is selected.
  • Priority visibility: Agreement priority is private to the Recipient. The Donor cannot see or set it.
  • Template changes: If a Recipient template referenced by an agreement is changed or deleted in a way that affects required inputs, the agreement is paused to prevent imports from running against an incompatible configuration.
  • Import mode: The Recipient can change its import mode without Donor approval.

Go-live boundary: Only customers approved while an agreement is live are shared automatically. Customers approved before the agreement's start date are not backfilled automatically. Contact the AiPrise team if you need a historical backfill.


Did this page help you?