Contact Info
Contact Info APIs expose and update customer contact data (phone, email, postal address) and notification (SMS, voice, email) for a financial institution customer.
End-user benefits
- Keep phone, email, and postal address up to date for digital banking profile and communications.
- Viewing contact destinations (SMS, voice, email) for verification and notifications.
- Support self-service password reset flows: integrators first list contact methods, then the customer selects where to receive an OTP.
Integration capabilities
- Managing customer contact data and notification (SMS, voice, email)
- Supporting self-service password reset flows
- Enabling integration with automation and admin tools
Scopes
| Scope | Description |
|---|---|
institution-users:read | Get contact methods for a customer (e.g. before password reset) |
institution-users:write | Trigger OTP / reset where applicable |
Required headers
| Header | Description |
|---|---|
Authorization | Bearer {token} (OAuth 2.0) |
correlationId | UUID for tracing (required) |
Error codes
| Code | Message | HTTP Status Code |
|---|---|---|
| UXU_10001 | Invalid JWT token | 400 |
| UXU_10002 | Required role not present in JWT token | 403 |
| UXU_10003 | JWT token has expired | 400 |
| UXU_10004 | JWT token does not contain institution id | 400 |
| UXU_10005 | Required Authorization header is missing | 400 |
| UXU_10006 | Required Correlation Id header is missing | 400 |
| UXU_10007 | Correlation Id is not a GUID | 400 |
| UXU_10008 | Invalid IP address in the header | 400 |
| UXU_10009 | Invalid Authorization in the header | 400 |
| UXU_10010 | JWT token does not contain institution customers id | 400 |
| UXU_10011 | JWT token institution customers id not matching path param | 400 |
| UXU_10012 | Invalid path param | 400 |
| UXU_10013 | Invalid path | 400 |
| UXU_10014 | Invalid query param | 400 |
| UXU_30001 | Error interacting with the service | 503 |
| UXU_30002 | Error interacting with the external service | 503 |
| UXU_88888 | No entitled customers found | 404 |
| UXU_88889 | Contact method Id not found | 400 |
| UXU_88890 | Institution customer id not found | 400 |
| UXU_88891 | Host phone postal address not found | 400 |
| UXU_99998 | Internal server error | 500 |
| UXU_99999 | Cannot handle this request — check URL, body and parameters | 400 |