Create Agent
POST /obp/v7.0.0/banks/BANK_ID/agents
OBPv5.1.0-createAgent No role required CustomerPerson
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields (4)
- agent_number
- 5987953
- currency
- EUR
- legal_name
- Eveline Tripman
- mobile_phone_number
- +49 30 901820
JSON response body fields (8)
- agent_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- agent_number
- 5987953
- bank_id
- gh.29.uk
- currency
- EUR
- is_confirmed_agent
- is_confirmed_agent
- is_pending_agent
- is_pending_agent
- legal_name
- Eveline Tripman
- mobile_phone_number
- +49 30 901820
Example request body
{
"legal_name": "Eveline Tripman",
"mobile_phone_number": "+49 30 901820",
"agent_number": "5987953",
"currency": "EUR"
}Example success response
{
"agent_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"bank_id": "gh.29.uk",
"legal_name": "Eveline Tripman",
"mobile_phone_number": "+49 30 901820",
"agent_number": "5987953",
"currency": "EUR",
"is_confirmed_agent": false,
"is_pending_agent": true
}Possible errors (6)
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-30328: Agent Number already exists. Please specify a different value for BANK_ID or AGENT_NUMBER.
- OBP-30202: Could not create Agent.
- OBP-50000: Unknown Error.