Skip to main content
Identify is the first workbench tool, and the only one live today. You send a rail and its code. Patchwork returns the institution, the payment rails it can be reached on, and — when you also pass an account_number on a supported rail — the resolved holder name. It is a bare REST product. You can call it with an API key and no agent. When the api_product binding ships, the same product can be wired into an agent as a patch.
Charged on an identified outcome. Promo credits cover first calls. There is no complimentary test lane.

Quickstart

A successful institution lookup looks like this:

Rails

Holder resolution is available on nuban, momo, and gh_bank. Pass account_number (or the wallet number) on those rails.
country is an optional ISO 3166-1 alpha-2 hint when the rail is ambiguous.

Results

data.result is one of identified, not_found, or unsupported. Only identified is billed. If a field is unknown we omit it — we do not send nulls. identified_at is present only on a match. The result object: The Identify Result object. The request: Identify an account.

Errors

Missing rail or code is MISSING_PARAMETER (400). An unknown rail is UNSUPPORTED_RAIL (400). Out of credits is 402. See Errors.