TransversePATH FINDER
SDK reference
Payee check
payeeCheck — verify a name or display it masked before sending. Answered by the holder.
payeeCheck(params)
Step 3 of reachability, PIP-0013. Sent to the holder, never to the network.
const check = await path.payeeCheck({
address: 'path:4a91c2f7e8d3',
endpointBase: 'https://api.member-b.com',
mode: 'verify',
name: 'Alice Martin',
context: { request: '7fk2m9pq3vx8' },
});
check.result; // "match" | "close_match" | "no_match" | "unavailable"
check.display_name; // "Alice M." — on close_match only| Param | Notes |
|---|---|
address | A PATH address issued by the holder |
endpointBase | The holder's base URL. Defaults to this client's |
mode | verify, with name; or display |
context | { request } or { instruction } issued for address. With it, nothing is signed |
nonce | Generated when omitted |
Without context, the call is signed with your member credential. A payee check is never a public
read.
display
const shown = await path.payeeCheck({ address, endpointBase, mode: 'display', context });
shown.result; // "shown" | "unavailable"
shown.display_name; // "Alice M."unavailable means not checked. Show it to the payer as missing information, never as a mismatch.
It returns no other identifier of the subject.
A holder that serves the call declares PATH-FINDER.PayeeCheck in its discovery document. The
reference implementation does.