API Explorer

								
									{
  "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
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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.

Connector Methods:

Version: OBPv5.1.0, function_name: by createAgent, operation_id: OBPv5.1.0-createAgent Tags: Customer, Person,

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.
Dates need to be in the format 2013-01-21T23:08:00Z

Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

currency: EUR

date: 2020-01-27

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

source:

url: http://www.example.com/id-docs/123/image.png

branch_id: DERBY6

credit_limit:

credit_rating:

customer_number: 5987953

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-12-11T21:00:24.360Z

name_suffix: Sr

relationship_status: single

title: Dr.

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

currency: EUR

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-12-11T21:00:24.360Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response:

								
									{
  "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":"2023-12-11T21:00:24Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCustomer - Please login to request this Role
CanCreateCustomerAtAnyBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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:

Connector Methods:

Version: OBPv5.0.0, function_name: by createCustomer, operation_id: OBPv5.0.0-createCustomer Tags: Customer, Person,

Update Agent status

Authentication is Mandatory

URL Parameters:

AGENT_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

BANK_ID: gh.29.uk

JSON response body fields:

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

Typical Successful 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
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateAgentStatusAtAnyBank - Please login to request this Role
CanUpdateAgentStatusAtOneBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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:

Connector Methods:

Version: OBPv5.1.0, function_name: by updateAgentStatus, operation_id: OBPv5.1.0-updateAgentStatus Tags: Customer, Person,

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID
Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

transport: SMS

JSON response body fields:

success:

Typical Successful Response:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCustomerMessage - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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:

Connector Methods:

Version: OBPv4.0.0, function_name: by createCustomerMessage, operation_id: OBPv4.0.0-createCustomerMessage Tags: Customer-Message, Customer, Person,

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

JSON response body fields:

success:

Typical Successful Response:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv1.4.0, function_name: by addCustomerMessage, operation_id: OBPv1.4.0-addCustomerMessage Tags: Customer-Message, Customer, Person,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v5.1.0 filtered by tag: Person (5 APIs)

Create Agent

Create Customer

Update Agent status

Create Customer Message

Create Customer Message