API Explorer

v5.1.0 (606 APIs)

Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Account Application

Create Account Application

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

product_code: 1234BW

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

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

account_application_id:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

currency: EUR

customer:

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 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-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

product_code: 1234BW

provider: ETHEREUM

provider_id:

rating:

relationship_status: single

source:

status:

title: Dr.

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

user:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

credit_limit:

credit_rating:

Respuesta Exitosa Típica:

								
									
{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"1234BW", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "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-10-28T22:23:21Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"1100-01-01T00:00:00Z", "status":"REQUESTED" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Métodos de conector::
Version: OBPv3.1.0, function_name: by createAccountApplication, operation_id: OBPv3.1.0-createAccountApplication Tags: Account-Application, Account,

Get Account Application by Id

Get the Account Application.

Authentication is Mandatory

URL Parameters:

ACCOUNT_APPLICATION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

account_application_id:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

currency: EUR

customer:

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 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-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

product_code: 1234BW

provider: ETHEREUM

provider_id:

rating:

relationship_status: single

source:

status:

title: Dr.

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

user:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

credit_limit:

credit_rating:

Respuesta Exitosa Típica:

								
									
{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"1234BW", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "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-10-28T22:23:21Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"1100-01-01T00:00:00Z", "status":"REQUESTED" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getAccountApplication, operation_id: OBPv3.1.0-getAccountApplication Tags: Account-Application, Account,

Get Account Applications

Get the Account Applications.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_application_id:

account_applications:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

currency: EUR

customer:

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 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-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

product_code: 1234BW

provider: ETHEREUM

provider_id:

rating:

relationship_status: single

source:

status:

title: Dr.

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

user:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

credit_limit:

credit_rating:

Respuesta Exitosa Típica:

								
									
{ "account_applications":[{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"1234BW", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "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-10-28T22:23:21Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"1100-01-01T00:00:00Z", "status":"REQUESTED" }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getAccountApplications, operation_id: OBPv3.1.0-getAccountApplications Tags: Account-Application, Account,

Update Account Application Status

Update an Account Application status

Authentication is Mandatory

URL Parameters:

ACCOUNT_APPLICATION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

account_application_id:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

currency: EUR

customer:

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

customer_number: 5987953

date: 2020-01-27

date_of_application: 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-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

product_code: 1234BW

provider: ETHEREUM

provider_id:

rating:

relationship_status: single

source:

status:

title: Dr.

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

user:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

credit_limit:

credit_rating:

Respuesta Exitosa Típica:

								
									
{ "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763", "product_code":"1234BW", "user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "customer":{ "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-10-28T22:23:21Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }, "date_of_application":"1100-01-01T00:00:00Z", "status":"REQUESTED" }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by updateAccountApplicationStatus, operation_id: OBPv3.1.0-updateAccountApplicationStatus Tags: Account-Application, Account,