{"resource_docs":[{"operation_id":"OBPv2.1.0-sandboxDataImport","implemented_by":{"version":"OBPv2.1.0","function":"sandboxDataImport"},"request_verb":"POST","request_url":"/obp/v2.1.0/sandbox/data-import","summary":"Create sandbox","description":"
Import bulk data into the sandbox (Authenticated access).
\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
\nThe user needs to have CanCreateSandbox entitlement.
\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
\nAn example of an import set of data (json) can be found here
\nAuthentication is Mandatory
JSON request body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\n\nactual_date: 2020-01-27
\n\namount: 10.12
\natms:
\nbalance: 10
\nbank:
\nbank_id: gh.29.uk
\n\n\n\n\ncity:
\ncode: 125
\ncompleted: 2020-01-27
\ncountry_code: 1254
\n\n\ncurrency: EUR
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nfull_name: full name string
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nlatitude: 38.8951
\n\n\n\n\n\nlogo: logo url
\nlongitude: -77.0364
\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nnew_balance: 20
\n\n\npassword: password
\npost_code: 789
\nposted: 2020-01-27
\n\n\n\n\n\n\ntype:
\nuser_name: felixsmith
\nusers: user list
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\naccount_number: 546387432
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\n\n","description_markdown":"Import bulk data into the sandbox (Authenticated access).\n\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.\n\nThe user needs to have CanCreateSandbox entitlement.\n\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.\n\nAn example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json)\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**actual_date**](/glossary#actual_date): 2020-01-27\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**atms**](/glossary#atms): \n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**banks**](/glossary#banks): \n\n\n\n[**branches**](/glossary#branches): \n\n\n\n[**category**](/glossary#category): \n\n\n\n[**channel**](/glossary#channel): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**crm_events**](/glossary#crm_events): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**details**](/glossary#details): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**family**](/glossary#family): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**generate_accountants_view**](/glossary#generate_accountants_view): \n\n\n\n[**generate_auditors_view**](/glossary#generate_auditors_view): \n\n\n\n[**generate_public_view**](/glossary#generate_public_view): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**password**](/glossary#): password\n\n\n\n[**post_code**](/glossary#post_code): 789\n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_name**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[account_number](/glossary#): 546387432\n\n\n\n[counterparty](/glossary#counterparty): \n\n\n\n[driveUp](/glossary#driveup): \n\n\n\n[lobby](/glossary#lobby): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"banks":[{"id":"bank1","short_name":"bank 1","full_name":"Bank 1 Inc.","logo":"http://example.com/logo","website":"http://example.com"},{"id":"bank2","short_name":"bank 2","full_name":"Bank 2 Inc.","logo":"http://example.com/logo2","website":"http://example.com/2"}],"users":[{"email":"user1@example.com","password":"TESOBE520berlin123!","user_name":"User 1"},{"email":"user2@example.com","password":"TESOBE520berlin123!","user_name":"User 2"}],"accounts":[{"id":"account1","bank":"bank1","label":"Account 1 at Bank 1","number":"1","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"1234567890","owners":["User 1"],"generate_public_view":true,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account2","bank":"bank1","label":"Account 2 at Bank 1","number":"2","type":"current","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"91234567890","owners":["User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account1","bank":"bank2","label":"Account 1 at Bank 2","number":"22","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"21234567890","owners":["User 1","User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true}],"transactions":[{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank2"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartNameTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"account_number":"123456-AVB"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartAccountNumberTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Piano Repair"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-with-counterparty","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Acme Inc.","account_number":"12345-B"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank1"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}}],"branches":[{"id":"branch1","bank_id":"bank1","name":"Genel Müdürlük","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}},{"id":"branch2","bank_id":"bank1","name":"Manchester","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}}],"atms":[{"id":"atm1","bank_id":"bank1","name":"Ashbourne Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"id":"atm2","bank_id":"bank1","name":"Manchester Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"products":[{"bank_id":"bank1","code":"prd1","name":"product 1","category":"cat1","family":"fam1","super_family":"sup fam 1","more_info_url":"www.example.com/index1","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"bank_id":"bank1","code":"prd2","name":"Product 2","category":"cat2","family":"fam2","super_family":"sup fam 2","more_info_url":"www.example.com/index2","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"crm_events":[{"id":"ASDFHJ47YKJH","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"1100-01-01T01:01:01.000Z"},{"id":"KIFJA76876AS","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"1100-01-01T01:01:01.000Z"}]},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-00002: Data import is disabled for this API instance.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Sandbox"],"typed_request_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"IBAN":{"type":"string"},"generate_accountants_view":{"type":"boolean"},"owners":{"type":"array","items":{"type":"string"}},"generate_public_view":{"type":"boolean"},"bank":{"type":"string"},"id":{"type":"string"},"generate_auditors_view":{"type":"boolean"},"label":{"type":"string"},"number":{"type":"string"},"balance":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"type":{"type":"string"}}}},"branches":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"driveUp":{"type":"object","properties":{"hours":{"type":"string"}}},"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"this_account":{"type":"object","properties":{"id":{"type":"string"},"bank":{"type":"string"}}},"details":{"type":"object","properties":{"value":{"type":"string"},"new_balance":{"type":"string"},"type":{"type":"string"},"completed":{"type":"string"},"posted":{"type":"string"},"description":{"type":"string"}}}}}},"products":{"type":"array","items":{"type":"object","properties":{"family":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"bank_id":{"type":"string"},"super_family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"code":{"type":"string"},"more_info_url":{"type":"string"}}}},"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"crm_events":{"type":"array","items":{"type":"object","properties":{"channel":{"type":"string"},"actual_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"customer":{"type":"object","properties":{"number":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"string"},"id":{"type":"string"},"detail":{"type":"string"}}}},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"user_name":{"type":"string"},"password":{"type":"string"}}}},"banks":{"type":"array","items":{"type":"object","properties":{"full_name":{"type":"string"},"short_name":{"type":"string"},"logo":{"type":"string"},"website":{"type":"string"},"id":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanCreateSandbox","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/sandbox/data-import","connector_methods":[]}]}