What your IT team can connect - API overview
For: bank IT and integration leads.
Not for: executives or credit operators (see Start here).
This page explains what you typically integrate for - in business outcomes. Path-level contracts live in the OpenAPI appendix.
:::tip Key takeaways
- Prefer Integrations for banks for patterns, auth concepts, and environments.
- Use
/openapiwhen you need the Pro Gateway operation list. - Sandbox vs production base URLs and credentials come from your contract / AIS account team - not from illustrative
serversin the published JSON.
:::
How systems connect
Machine integrations usually go through the Pro Gateway; staff use Decision PRO; Akafay is the customer channel where contracted.
Outcomes your bank usually cares about
| Outcome | Plain meaning |
|---|---|
| Score / assess | Request a credit assessment for an applicant or application context. |
| Decide / workflow | Exchange decision or status events your core or channel needs. |
| Notify / webhook | Receive or send events when cases move (where contracted). |
| Staff UI | Many banks also use Decision PRO without building every screen themselves. |
Exact operations depend on your SKU and contract. Confirm with AIS before designing against every path in the appendix.
Recommended reading order
- Integration patterns
- Authentication concepts
- Environments
- Interactive appendix: OpenAPI (Redoc)
- Staff notes on the JSON snapshot: OpenAPI reference
What not to do
- Do not treat documentation examples as production secrets or live URLs.
- Do not skip your bank’s security review because an OpenAPI file is public on this portal.
- Do not assume Akafay channel APIs and Decision PRO gateway paths are identical - confirm routing with AIS.
Related products: How products fit · Akafay · Decision PRO