{"resource_docs":[{"operation_id":"OBPv4.0.0-createCustomerMessage","implemented_by":{"version":"OBPv4.0.0","function":"createCustomerMessage"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/messages","summary":"Create Customer Message","description":"<p>Create a message for the customer specified by CUSTOMER_ID<br />\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>URL Parameters:</strong></p>\n<p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p>\n<p><a href=\"/glossary#Customer.customer_id\">CUSTOMER_ID</a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p>\n<p><strong>JSON request body fields:</strong></p>\n<p><a href=\"/glossary#from_department\"><strong>from_department</strong></a>: Open Bank</p>\n<p><a href=\"/glossary#from_person\"><strong>from_person</strong></a>: Tom</p>\n<p><a href=\"/glossary#message\"><strong>message</strong></a>: 123456</p>\n<p><a href=\"/glossary#transport\"><strong>transport</strong></a>: SMS</p>\n<p><strong>JSON response body fields:</strong></p>\n<p><strong>success</strong>:</p>\n","description_markdown":"Create a message for the customer specified by CUSTOMER_ID\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**transport**](/glossary#transport): SMS\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n**success**: \n\n\n","example_request_body":{"message":"123456","transport":"SMS","from_department":"Open Bank","from_person":"Tom"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: "],"tags":["Customer-Message","Customer","Person"],"typed_request_body":{"type":"object","properties":{"transport":{"type":"string"},"from_person":{"type":"string"},"from_department":{"type":"string"},"message":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanCreateCustomerMessage","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/messages","connector_methods":[]},{"operation_id":"OBPv1.4.0-addCustomerMessage","implemented_by":{"version":"OBPv1.4.0","function":"addCustomerMessage"},"request_verb":"POST","request_url":"/obp/v1.4.0/banks/BANK_ID/customer/CUSTOMER_ID/messages","summary":"Create Customer Message","description":"<p>Create a message for the customer specified by CUSTOMER_ID</p>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>URL Parameters:</strong></p>\n<p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p>\n<p><a href=\"/glossary#Customer.customer_id\">CUSTOMER_ID</a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p>\n<p><strong>JSON request body fields:</strong></p>\n<p><a href=\"/glossary#from_department\"><strong>from_department</strong></a>: Open Bank</p>\n<p><a href=\"/glossary#from_person\"><strong>from_person</strong></a>: Tom</p>\n<p><a href=\"/glossary#message\"><strong>message</strong></a>: 123456</p>\n<p><strong>JSON response body fields:</strong></p>\n<p><strong>success</strong>:</p>\n","description_markdown":"Create a message for the customer specified by CUSTOMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n**success**: \n\n\n","example_request_body":{"message":"String","from_department":"String","from_person":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer-Message","Customer","Person"],"typed_request_body":{"type":"object","properties":{"message":{"type":"string"},"from_department":{"type":"string"},"from_person":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customer/CUSTOMER_ID/messages","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateAgentStatus","implemented_by":{"version":"OBPv5.1.0","function":"updateAgentStatus"},"request_verb":"PUT","request_url":"/obp/v5.1.0/banks/BANK_ID/agents/AGENT_ID","summary":"Update Agent status","description":"<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>URL Parameters:</strong></p>\n<p><a href=\"/glossary#Agent.agent_id\">AGENT_ID</a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p>\n<p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p>\n<p><strong>JSON response body fields:</strong></p>\n<p><a href=\"/glossary#Agent.agent_id\"><strong>agent_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p>\n<p><a href=\"/glossary#Agent.agent_number\"><strong>agent_number</strong></a>: 5987953</p>\n<p><a href=\"/glossary#Bank.bank_id\"><strong>bank_id</strong></a>: gh.29.uk</p>\n<p><strong>currency</strong>: EUR</p>\n<p><strong>is_confirmed_agent</strong>: is_confirmed_agent</p>\n<p><strong>is_pending_agent</strong>: is_pending_agent</p>\n<p><strong>legal_name</strong>: Eveline Tripman</p>\n<p><a href=\"/glossary#mobile_phone_number\"><strong>mobile_phone_number</strong></a>: +49 30 901820</p>\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[AGENT_ID](/glossary#Agent.agent_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**agent_id**](/glossary#Agent.agent_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**agent_number**](/glossary#Agent.agent_number): 5987953\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n**currency**: EUR\n\n\n\n**is_confirmed_agent**: is_confirmed_agent\n\n\n\n**is_pending_agent**: is_pending_agent\n\n\n\n**legal_name**: Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n","example_request_body":{"is_pending_agent":false,"is_confirmed_agent":true},"success_response_body":{"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},"error_response_bodies":["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-30201: Agent not found. Please specify a valid value for AGENT_ID. ","OBP-30325: Agent Account Link not found.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","Person"],"typed_request_body":{"type":"object","properties":{"is_pending_agent":{"type":"boolean"},"is_confirmed_agent":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"bank_id":{"type":"string"},"currency":{"type":"string"},"mobile_phone_number":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"},"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"}}},"roles":[{"role":"CanUpdateAgentStatusAtAnyBank","requires_bank_id":false},{"role":"CanUpdateAgentStatusAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/agents/AGENT_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-createCustomer","implemented_by":{"version":"OBPv5.0.0","function":"createCustomer"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/customers","summary":"Create Customer","description":"<p>The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.<br />\nDates need to be in the format 2013-01-21T23:08:00Z</p>\n<p>If kyc_status is not provided, it defaults to false.</p>\n<p>Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.</p>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>URL Parameters:</strong></p>\n<p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p>\n<p><strong>JSON request body fields:</strong></p>\n<p><strong>amount</strong>: 10.12</p>\n<p><strong>currency</strong>: EUR</p>\n<p><strong>date</strong>: 2020-01-27</p>\n<p><strong>legal_name</strong>: Eveline Tripman</p>\n<p><a href=\"/glossary#mobile_phone_number\"><strong>mobile_phone_number</strong></a>: +49 30 901820</p>\n<p><a href=\"/glossary#Customer.Credit.rating\"><strong>rating</strong></a>:</p>\n<p><a href=\"/glossary#Customer.Credit.source\"><strong>source</strong></a>:</p>\n<p><a href=\"/glossary#Customer.url\"><strong>url</strong></a>: <a href=\"http://www.example.com/id-docs/123/image.png\">http://www.example.com/id-docs/123/image.png</a></p>\n<p><a href=\"/glossary#Branch.branch_id\">branch_id</a>: DERBY6</p>\n<p>credit_limit:</p>\n<p>credit_rating:</p>\n<p>customer_number: 5987953</p>\n<p>date_of_birth: 2018-03-09</p>\n<p><a href=\"/glossary#Customer.dependants\">dependants</a>: 1</p>\n<p><a href=\"/glossary#dob_of_dependants\">dob_of_dependants</a>: [2019-09-08, 2017-07-12]</p>\n<p>email: <a href=\"mailto:felixsmith@example.com\">felixsmith@example.com</a></p>\n<p>employment_status: worker</p>\n<p>face_image:</p>\n<p>highest_education_attained: Master</p>\n<p>kyc_status: false</p>\n<p><a href=\"/glossary#last_ok_date\">last_ok_date</a>: 2025-10-15T02:00:30.613Z</p>\n<p>name_suffix: Sr</p>\n<p>relationship_status: single</p>\n<p><a href=\"/glossary#Customer.title\">title</a>: Dr.</p>\n<p><strong>JSON response body fields:</strong></p>\n<p><strong>amount</strong>: 10.12</p>\n<p><a href=\"/glossary#Bank.bank_id\"><strong>bank_id</strong></a>: gh.29.uk</p>\n<p><a href=\"/glossary#Branch.branch_id\"><strong>branch_id</strong></a>: DERBY6</p>\n<p><strong>currency</strong>: EUR</p>\n<p><a href=\"/glossary#Customer.customer_id\"><strong>customer_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p>\n<p><strong>customer_number</strong>: 5987953</p>\n<p><strong>date</strong>: 2020-01-27</p>\n<p><strong>date_of_birth</strong>: 2018-03-09</p>\n<p><a href=\"/glossary#Customer.dependants\"><strong>dependants</strong></a>: 1</p>\n<p><a href=\"/glossary#dob_of_dependants\"><strong>dob_of_dependants</strong></a>: [2019-09-08, 2017-07-12]</p>\n<p><strong>email</strong>: <a href=\"mailto:felixsmith@example.com\">felixsmith@example.com</a></p>\n<p><strong>employment_status</strong>: worker</p>\n<p><strong>face_image</strong>:</p>\n<p><strong>highest_education_attained</strong>: Master</p>\n<p><strong>kyc_status</strong>: false</p>\n<p><a href=\"/glossary#last_ok_date\"><strong>last_ok_date</strong></a>: 2025-10-15T02:00:30.613Z</p>\n<p><strong>legal_name</strong>: Eveline Tripman</p>\n<p><a href=\"/glossary#mobile_phone_number\"><strong>mobile_phone_number</strong></a>: +49 30 901820</p>\n<p><strong>name_suffix</strong>: Sr</p>\n<p><a href=\"/glossary#Customer.Credit.rating\"><strong>rating</strong></a>:</p>\n<p><strong>relationship_status</strong>: single</p>\n<p><a href=\"/glossary#Customer.Credit.source\"><strong>source</strong></a>:</p>\n<p><a href=\"/glossary#Customer.title\"><strong>title</strong></a>: Dr.</p>\n<p><a href=\"/glossary#Customer.url\"><strong>url</strong></a>: <a href=\"http://www.example.com/id-docs/123/image.png\">http://www.example.com/id-docs/123/image.png</a></p>\n<p>credit_limit:</p>\n<p>credit_rating:</p>\n","description_markdown":"The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.\nDates need to be in the format 2013-01-21T23:08:00Z\n\nIf kyc_status is not provided, it defaults to false.\n\nNote: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n**amount**: 10.12\n\n\n\n**currency**: EUR\n\n\n\n**date**: 2020-01-27\n\n\n\n**legal_name**: Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#Customer.Credit.rating): \n\n\n\n[**source**](/glossary#Customer.Credit.source): \n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n[branch_id](/glossary#Branch.branch_id): DERBY6\n\n\n\ncredit_limit: \n\n\n\ncredit_rating: \n\n\n\ncustomer_number: 5987953\n\n\n\ndate_of_birth: 2018-03-09\n\n\n\n[dependants](/glossary#Customer.dependants): 1\n\n\n\n[dob_of_dependants](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\nemail: felixsmith@example.com\n\n\n\nemployment_status: worker\n\n\n\nface_image: \n\n\n\nhighest_education_attained: Master\n\n\n\nkyc_status: false\n\n\n\n[last_ok_date](/glossary#last_ok_date): 2025-10-15T02:00:30.613Z\n\n\n\nname_suffix: Sr\n\n\n\nrelationship_status: single\n\n\n\n[title](/glossary#Customer.title): Dr.\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n**amount**: 10.12\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[**branch_id**](/glossary#Branch.branch_id): DERBY6\n\n\n\n**currency**: EUR\n\n\n\n[**customer_id**](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n**customer_number**: 5987953\n\n\n\n**date**: 2020-01-27\n\n\n\n**date_of_birth**: 2018-03-09\n\n\n\n[**dependants**](/glossary#Customer.dependants): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n**email**: felixsmith@example.com\n\n\n\n**employment_status**: worker\n\n\n\n**face_image**: \n\n\n\n**highest_education_attained**: Master\n\n\n\n**kyc_status**: false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-10-15T02:00:30.613Z\n\n\n\n**legal_name**: Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n**name_suffix**: Sr\n\n\n\n[**rating**](/glossary#Customer.Credit.rating): \n\n\n\n**relationship_status**: single\n\n\n\n[**source**](/glossary#Customer.Credit.source): \n\n\n\n[**title**](/glossary#Customer.title): Dr.\n\n\n\n[**url**](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\ncredit_limit: \n\n\n\ncredit_rating: \n\n\n","example_request_body":{"legal_name":"Eveline Tripman","customer_number":"5987953","mobile_phone_number":"+49 30 901820","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-10-15T02:00:42Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1100-01-01T00:00:00Z"},"date_of_birth":"1100-01-01T00:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1100-01-01T00:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-10-15T02:00:41Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"error_response_bodies":["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-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID","OBP-30024: Could not create Consumer ","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","Person"],"typed_request_body":{"type":"object","properties":{"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"employment_status":{"type":"string"},"kyc_status":{"type":"boolean"},"mobile_phone_number":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"customer_number":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"dependants":{"type":"integer"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"email":{"type":"string"},"name_suffix":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"highest_education_attained":{"type":"string"},"relationship_status":{"type":"string"},"branch_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"email":{"type":"string"},"date_of_birth":{"type":"string","format":"date-time"},"kyc_status":{"type":"boolean"},"legal_name":{"type":"string"},"employment_status":{"type":"string"},"mobile_phone_number":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"customer_id":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"bank_id":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"dependants":{"type":"integer"},"relationship_status":{"type":"string"},"highest_education_attained":{"type":"string"}}},"roles":[{"role":"CanCreateCustomer","requires_bank_id":true},{"role":"CanCreateCustomerAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers","connector_methods":[]},{"operation_id":"OBPv5.1.0-createAgent","implemented_by":{"version":"OBPv5.1.0","function":"createAgent"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/agents","summary":"Create Agent","description":"<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>URL Parameters:</strong></p>\n<p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p>\n<p><strong>JSON request body fields:</strong></p>\n<p><a href=\"/glossary#Agent.agent_number\"><strong>agent_number</strong></a>: 5987953</p>\n<p><strong>currency</strong>: EUR</p>\n<p><strong>legal_name</strong>: Eveline Tripman</p>\n<p><a href=\"/glossary#mobile_phone_number\"><strong>mobile_phone_number</strong></a>: +49 30 901820</p>\n<p><strong>JSON response body fields:</strong></p>\n<p><a href=\"/glossary#Agent.agent_id\"><strong>agent_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p>\n<p><a href=\"/glossary#Agent.agent_number\"><strong>agent_number</strong></a>: 5987953</p>\n<p><a href=\"/glossary#Bank.bank_id\"><strong>bank_id</strong></a>: gh.29.uk</p>\n<p><strong>currency</strong>: EUR</p>\n<p><strong>is_confirmed_agent</strong>: is_confirmed_agent</p>\n<p><strong>is_pending_agent</strong>: is_pending_agent</p>\n<p><strong>legal_name</strong>: Eveline Tripman</p>\n<p><a href=\"/glossary#mobile_phone_number\"><strong>mobile_phone_number</strong></a>: +49 30 901820</p>\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**agent_number**](/glossary#Agent.agent_number): 5987953\n\n\n\n**currency**: EUR\n\n\n\n**legal_name**: Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**agent_id**](/glossary#Agent.agent_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**agent_number**](/glossary#Agent.agent_number): 5987953\n\n\n\n[**bank_id**](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n**currency**: EUR\n\n\n\n**is_confirmed_agent**: is_confirmed_agent\n\n\n\n**is_pending_agent**: is_pending_agent\n\n\n\n**legal_name**: Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n","example_request_body":{"legal_name":"Eveline Tripman","mobile_phone_number":"+49 30 901820","agent_number":"5987953","currency":"EUR"},"success_response_body":{"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},"error_response_bodies":["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."],"tags":["Customer","Person"],"typed_request_body":{"type":"object","properties":{"currency":{"type":"string"},"mobile_phone_number":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bank_id":{"type":"string"},"currency":{"type":"string"},"mobile_phone_number":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"},"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/agents","connector_methods":[]}]}