Profile And Status
Profile and Status APIs return user profile information and user status.
End-user benefits
- View profile context: name, demographics, login identifiers, contact methods, addresses, entitled relationships, user products, and channel login data.
- Understand access state: active, locked, on hold, registration/approval, failed logins/resets, sub-users.
Integration capabilities
- Access core user profile data to support identity verification and entitlement validation.
- Retrieve real-time user status to enable eligibility checks, compliance, and consistent experiences.
FI customer ID types
The fiCustomerIdType parameter supports multiple identifier types:
| Type | Description |
|---|---|
| GUID | Internal ID (default) |
| MEMNUMBER | Financial institution's core system ID |
| LOGINID | Customer's digital banking login ID |
| HOSTID | Host system identifier |
Scopes
Institution user, user status, and customer profile
| Scope | Description |
|---|---|
institution-users:read | Read institution users |
Banking activities
| Scope | Description |
|---|---|
banking-activities:read | Read banking activities |
Error codes
FI customer
| Code | Message | HTTP Status Code |
|---|---|---|
| USER_ERROR | Bad Request - Invalid fiCustomerIdType | 400 |
| APP_ERROR | Unauthorized Access | 401 |
| APP_ERROR | FICustomer does not exist | 404 |
| SYSTEM_ERROR | Internal server error | 500 |
| SYSTEM_ERROR | Circuit breaker open or throttle limit reached | 503 |
Institution user and user status
| Code | Message | HTTP Status Code |
|---|---|---|
| ISR_10001 | InstitutionUser not found | 400 |
| ISR_10002 | Primary InstitutionUser not found | 400 |
| ISR_10009 | Error processing OData expression | 400 |
| ISR_10010 | The CIF number is required, but was not found | 500 |
| ISR_10032 | Invalid request | 500 |
| ISR_11007 | Invalid path param | 400 |
| ISR_11008 | Invalid query param | 400 |
| ISR_23004 | Error interacting with host | 500 |
| ISR_88888 | Internal validation error | 500 |
| ISR_99999 | Internal server error | 500 |
Customer profile
| 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_88890 | Institution customer id not found | 400 |
| UXU_99998 | Internal server error | 500 |
| UXU_99999 | Cannot handle this request — check URL, body and parameters | 400 |
Endpoints
Get Customer Profile
Returns the customer's profile for the specified identifier. This includes personal details (name and demographics), login identifiers,
Get Profile Information
Retrieves digital banking profile information for a customer. This endpoint provides comprehensive customer data from the Digital Banking system.
Get Institution User by ID
Get Institution User by ID
Get User Status
Retrieves comprehensive status information for a specified primary user, including account activity indicators such as active, locked, on hold, and registration status. If the user has associated sub-users, their respective status details are also included. Requires OAuth 2.0 Bearer token and transaction ID for authentication and traceability.