Journey 6 of 7
Integrate
The architecture, how calls authenticate, the error protocol, and the API reference generated from its contract.
Journey steps
- Architecture overviewThe platform's planes, the isolation of each institution and the standard components used.
- API authentication: tokens and credentialsHow an API call is authenticated: a staff member's session token, second factor, step-up verification, machine credentials and correlation.
- Error protocolFormat of API error responses (RFC 9457), stable codes, categories and HTTP statuses, correlation identifier and confidentiality rules.
- API referenceEvery operation in the contract, with its parameters, bodies, responses and validated synthetic examples.