GitHub
TransversePATH CROSSWAY

API reference

PAYEE CHECK

Crossway stage 4 — verify a name, or display it masked, using the external scheme's own check. Never a profile.

LIVE — PIP-0014.

Private access. The Crossway API is operated by Path Global. Access is closed and granted per client and per registry, on request at pathglobal.finance. Requests are signed as in Authentication, under a key issued by Path Global, and sent from your server only.

https://api.pathglobal.finance/crossway/v1

The two modes of the PATH payee check, mapped onto each external scheme. See the spec.


POST /payee-check

{
  "registry": "pix.dict",
  "key_type": "phone",
  "key": "+5511987654321",
  "mode": "verify",
  "name": "Alice Martin",
  "purpose": "payment_preparation",
  "nonce": "7d1e2c9f4b03"
}

Response

{
  "kind": "crossway.payee_check",
  "registry": "pix.dict",
  "requester": "client-fintech-a",
  "mode": "verify",
  "result": "close_match",
  "display_name": "Alice M.",
  "connector": "pathglobal-br-01",
  "attestation": "att_9kq3m7vx2pf8",
  "nonce": "7d1e2c9f4b03",
  "signed_at": "2026-10-05T10:00:00Z",
  "kid": "pg_crossway_2026_01",
  "signature": "…"
}

result is match, close_match, no_match, unavailable, or shown in display mode, as in PIP-0013. Where the scheme has no name check, unavailable.

RegistryWhat the scheme provides
pix.dictThe registered name, shown masked
pi-spi.aliasThe registered name, shown masked
upi.vpaThe registered name, shown masked
sepa-inst.vopVerification of Payee: match, close match, no match

Never returned: the subject's other identifiers, a tax number in the clear, account details.

Errors

As for SONAR.

On this page