Skip to main content
An ultimate payor is the business one of your sub-clients pays on behalf of. You register it once for that sub-client. Kira screens it against anti-money-laundering lists, and you name it on every payout the sub-client makes on its behalf. A sub-client has to hold the pobo capability before it can have an ultimate payor. Request a capability is how it gets one.

Example

Fields

How a payor clears

The screening starts when you create the payor, and it finishes after that call has returned.
  1. Create an ultimate payor. The answer carries the payor’s id and its first status: verifying when the check started, failed when it could not start.
  2. Read status with Get an ultimate payor until it reaches a verdict. No webhook reports the screening.
  3. Make the payout on the payor’s behalf once status is verified. While it holds any other value, a payout naming the payor is refused.
A verified payor can still become rejected later, so a payor that cleared once is not cleared for good. Payouts naming it are refused from then on.