Get Current Consumer
GET /obp/v7.0.0/consumers/current
OBPv6.0.0-getCurrentConsumer Roles: CanGetCurrentConsumer ConsumerAPI
Returns the consumer_id of the current authenticated consumer.
This endpoint requires authentication via:
- User authentication (OAuth, DirectLogin, etc.) - returns the consumer associated with the user's session
- Consumer/Client authentication - returns the consumer credentials being used
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (23)
- active_at_date
- active_at_date
- active_per_day_rate_limit
- active_per_day_rate_limit
- active_per_hour_rate_limit
- active_per_hour_rate_limit
- active_per_minute_rate_limit
- active_per_minute_rate_limit
- active_per_month_rate_limit
- active_per_month_rate_limit
- active_per_second_rate_limit
- active_per_second_rate_limit
- active_per_week_rate_limit
- active_per_week_rate_limit
- active_rate_limits
- active_rate_limits
- app_name
- appNameBank
- app_type
- Web
- call_counters
- call_counters
- considered_rate_limit_ids
- considered_rate_limit_ids
- consumer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- per_day
- 4000
- per_hour
- per_minute
- per_month
- 500
- per_second
- 1000
- per_week
- 50000
- status
- calls_made
- 50
- reset_in_seconds
Example success response
{
"app_name": "SOFI",
"app_type": "Web",
"description": "Account Management",
"consumer_id": "123",
"active_rate_limits": {
"considered_rate_limit_ids": [
"80e1e0b2-d8bf-4f85-a579-e69ef36e3305"
],
"active_at_date": "1100-01-01T00:00:00Z",
"active_per_second_rate_limit": 100,
"active_per_minute_rate_limit": 1000,
"active_per_hour_rate_limit": -1,
"active_per_day_rate_limit": -1,
"active_per_week_rate_limit": -1,
"active_per_month_rate_limit": -1
},
"call_counters": {
"per_second": {
"calls_made": 42,
"reset_in_seconds": 15,
"status": "ACTIVE"
},
"per_minute": {
"calls_made": 42,
"reset_in_seconds": 15,
"status": "ACTIVE"
},
"per_hour": {
"calls_made": 42,
"reset_in_seconds": 15,
"status": "ACTIVE"
},
"per_day": {
"calls_made": 42,
"reset_in_seconds": 15,
"status": "ACTIVE"
},
"per_week": {
"calls_made": 42,
"reset_in_seconds": 15,
"status": "ACTIVE"
},
"per_month": {
"calls_made": 42,
"reset_in_seconds": 15,
"status": "ACTIVE"
}
}
}Possible errors (4)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20009: Invalid consumer credentials
- OBP-50000: Unknown Error.