{
  "akka":{
    "ports":[{
      "property":"default",
      "value":"8080"
    }],
    "log_level":"Debug",
    "remote_data_secret_matched":true
  },
  "elastic_search":{
    "metrics":[{
      "property":"String",
      "value":"Mapper"
    }],
    "warehouse":[{
      "property":"String",
      "value":"ElasticSearch"
    }]
  },
  "cache":[{
    "function_name":"getBanks",
    "ttl_in_seconds":5
  }]
}
								
							

• CanGetConfig - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "version":"String",
  "version_status":"String",
  "git_commit":"String",
  "connector":"String",
  "hosted_by":{
    "organisation":"String",
    "email":"String",
    "phone":"String",
    "organisation_website":"String"
  }
}
								
							

• OBP-50000: Unknown Error.
• no connector set

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
								
							

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

								
									
{
  "name":"String",
  "version":"String",
  "git_commit":"String",
  "date":"2013-01-21T23:08:00Z"
}
								
							

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

								
									
{
  "connector_version":"kafka_vSept2018",
  "git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
  "duration_time":"10 ms"
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "kty":"RSA",
  "e":"AQAB",
  "use":"sig",
  "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s",
  "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "jwks_uris":[{
    "jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"
  }]
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "enabled":true,
  "technology":"REDIS",
  "service_available":true,
  "is_active":true
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "id":"atm-id-123",
  "bank_id":"bank-id-123",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"Full service store",
  "more_info":"short walk to the lake from here",
  "has_deposit_capability":"true"
}
								
							

• CanCreateAtm - Please login to request this Role
• CanCreateAtmAtAnyBank - Please login to request this Role

• 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:
• OBP-50000: Unknown Error.

								
									
{
  "id":"atm-id-123",
  "bank_id":"bank-id-123",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"Full service store",
  "more_info":"short walk to the lake from here",
  "has_deposit_capability":"true"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30009: ATM not found. Please specify a valid value for ATM_ID.
• OBP-50000: Unknown Error.

								
									
{
  "id":"atm-id-123",
  "bank_id":"bank-id-123",
  "name":"Atm by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  },
  "monday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "tuesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "wednesday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "thursday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "friday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "saturday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "sunday":{
    "opening_time":"10:00",
    "closing_time":"18:00"
  },
  "is_accessible":"true",
  "located_at":"Full service store",
  "more_info":"short walk to the lake from here",
  "has_deposit_capability":"true"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• No ATMs available. License may not be set.
• OBP-50000: Unknown Error.

								
									
{
  "answer":"yes",
  "date":"2019-05-03T14:15:02Z",
  "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-20054: Invalid amount. Please specify a valid value for amount.
• OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
• OBP-50000: Unknown Error.

								
									
{
  "user_id":"66214b8e-259e-44ad-8868-3eb47be70646",
  "label":"Label",
  "type":"CURRENT",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "branch_id":"1234",
  "account_routing":{
    "scheme":"OBP",
    "address":"UK123456"
  }
}
								
							

• CanCreateAccount - Please login to request this Role

• OBP-10001: Incorrect json format.
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-20001: User not logged in. Authentication is required!
• OBP-30107: Invalid User Id.
• OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-20005: User not found. Please specify a valid value for USER_ID.
• OBP-20006: User is missing one or more roles:
• OBP-30106: Invalid Balance Amount.
• OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
• OBP-30109: Initial Balance of Account must be Zero (0).
• OBP-30105: Invalid Balance Currency.
• OBP-30208: Account_ID already exists at the Bank.
• OBP-50000: Unknown Error.

								
									
{
  "bank_id":"123",
  "account_id":"456",
  "product_code":"saving1",
  "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "name":"OVERDRAFT_START_DATE",
  "type":"DATE_WITH_DAY",
  "value":"2012-04-23"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"OBP",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"10"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}
								
							

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-50000: Unknown Error.

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"OBP",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"10"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}
								
							

• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"12314",
    "bank_id":"123",
    "number":"123",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }]
  }]
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":false
    }]
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
								
							

• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":false
    }]
  }]
}
								
							

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

								
									
{
  "account":{
    "bank_id":"10",
    "account_id":"xjfsafjj",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "branch_routings":[{
      "scheme":"BranchNumber",
      "address":"678"
    }]
  },
  "orders":[{
    "order":{
      "order_id":"xjksajfkj",
      "order_date":"07082013",
      "number_of_checkbooks":"4",
      "distribution_channel":"1201",
      "status":"2",
      "first_check_number":"5165276",
      "shipping_code":"1"
    }
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-50211: Connector did not return the set of check book.
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-10001: Incorrect json format.
• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• user does not have access to owner view on account

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "customer":{
    "bank_id":"bankid1234",
    "customer_id":"123",
    "customer_number":"123",
    "legal_name":"legal_name",
    "mobile_phone_number":"123",
    "email":"contact@tesobe.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"123",
    "dependants":123,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"123",
    "employment_status":"123",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branchId":"12314",
    "nameSuffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
								
							

• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "customer":{
    "bank_id":"bankid1234",
    "customer_id":"123",
    "customer_number":"123",
    "legal_name":"legal_name",
    "mobile_phone_number":"123",
    "email":"contact@tesobe.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"123",
    "dependants":123,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"123",
    "employment_status":"123",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branchId":"12314",
    "nameSuffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "account_applications":[{
    "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
    "product_code":"saveing1",
    "user":{
      "user_id":"123",
      "email":"contact@tesobe.com",
      "provider_id":"obp",
      "provider":"obp",
      "username":"TESOBE"
    },
    "customer":{
      "bank_id":"bankid1234",
      "customer_id":"123",
      "customer_number":"123",
      "legal_name":"legal_name",
      "mobile_phone_number":"123",
      "email":"contact@tesobe.com",
      "face_image":{
        "url":"www.openbankproject",
        "date":"2017-09-19T00:00:00Z"
      },
      "date_of_birth":"2017-09-19T00:00:00Z",
      "relationship_status":"123",
      "dependants":123,
      "dob_of_dependants":["2017-09-19T00:00:00Z"],
      "credit_rating":{
        "rating":"OBP",
        "source":"OBP"
      },
      "credit_limit":{
        "currency":"EUR",
        "amount":"10"
      },
      "highest_education_attained":"123",
      "employment_status":"123",
      "kyc_status":true,
      "last_ok_date":"2017-09-19T00:00:00Z",
      "title":"Dr.",
      "branchId":"12314",
      "nameSuffix":"Sr"
    },
    "date_of_application":"2017-09-19T00:00:00Z",
    "status":"REQUESTED"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "customer":{
    "bank_id":"bankid1234",
    "customer_id":"123",
    "customer_number":"123",
    "legal_name":"legal_name",
    "mobile_phone_number":"123",
    "email":"contact@tesobe.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"123",
    "dependants":123,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"123",
    "employment_status":"123",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branchId":"12314",
    "nameSuffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "bank_id":"String",
    "label":"String",
    "number":"String",
    "owners":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"OBP",
      "display_name":"OBP"
    }],
    "type":"String",
    "balance":{
      "currency":"EUR",
      "amount":"10"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_rules":[{
      "scheme":"OVERDRAFT",
      "value":"10"
    }]
  }]
}
								
							

• CanUseFirehoseAtAnyBank - Please login to request this Role

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

								
									
{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "metadata":{
        "public_alias":"NONE",
        "private_alias":"NONE",
        "more_info":"www.openbankproject.com",
        "URL":"www.openbankproject.com",
        "image_URL":"www.openbankproject.com",
        "open_corporates_URL":"www.openbankproject.com",
        "corporate_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        },
        "physical_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        }
      }
    },
    "details":{
      "type":"AC",
      "description":"this is for family",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"10"
      },
      "value":{
        "currency":"EUR",
        "amount":"10"
      }
    },
    "metadata":{
      "narrative":"NONE",
      "comments":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "tags":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "images":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "label":"NONE",
        "URL":"www.openbankproject.com",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "where":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }
    }
  }]
}
								
							

• CanUseFirehoseAtAnyBank - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-00009: Firehose views not allowed on this instance. Please set allow_firehose_views = true in props files.
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "metadata":{
        "public_alias":"NONE",
        "private_alias":"NONE",
        "more_info":"www.openbankproject.com",
        "URL":"www.openbankproject.com",
        "image_URL":"www.openbankproject.com",
        "open_corporates_URL":"www.openbankproject.com",
        "corporate_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        },
        "physical_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        }
      }
    },
    "details":{
      "type":"AC",
      "description":"this is for family",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"10"
      },
      "value":{
        "currency":"EUR",
        "amount":"10"
      }
    },
    "metadata":{
      "narrative":"NONE",
      "comments":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "tags":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "images":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "label":"NONE",
        "URL":"www.openbankproject.com",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "where":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }
    }
  }]
}
								
							

• CanUseFirehoseAtAnyBank - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-00009: Firehose views not allowed on this instance. Please set allow_firehose_views = true in props files.
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"OBP",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"10"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}
								
							

• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}
								
							

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

								
									
{
  "id":"gh.29.uk.x",
  "full_name":"uk",
  "short_name":"uk",
  "logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png",
  "website_url":"https://www.example.com",
  "swift_bic":"IIIGGB22",
  "national_identifier":"UK97ZZZ1234567890",
  "bank_routing":{
    "scheme":"BIC",
    "address":"OKOYFIHH"
  }
}
								
							

• CanCreateBank - Please login to request this Role

• OBP-10001: Incorrect json format.
• OBP-20001: User not logged in. Authentication is required!
• OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
• OBP-50000: Unknown Error.

								
									
{
  "id":{
    "value":"123"
  },
  "bankId":{
    "value":"gh.uk.9j"
  },
  "shortCode":"80080",
  "summary":"SANSANDBOX_TAN",
  "description":"This is the sandbox mode, charging litter money.",
  "charge":{
    "currency":"EUR",
    "amount":"100"
  }
}
								
							

• CanCreateTransactionType - Please login to request this Role

• 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-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.
• OBP-50000: Unknown Error.

								
									
{
  "id":"gh.29.uk",
  "short_name":"short_name ",
  "full_name":"full_name",
  "logo":"logo",
  "website":"www.openbankproject.com",
  "bank_routing":{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  }
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.

								
									
{
  "banks":[{
    "id":"gh.29.uk",
    "short_name":"short_name ",
    "full_name":"full_name",
    "logo":"logo",
    "website":"www.openbankproject.com",
    "bank_routing":{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    }
  }]
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "transaction_types":[{
    "id":{
      "value":"123"
    },
    "bank_id":"PlaceholderString",
    "short_code":"PlaceholderString",
    "summary":"PlaceholderString",
    "description":"PlaceholderString",
    "charge":{
      "currency":"EUR",
      "amount":"10"
    }
  }]
}
								
							

• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "id":"branch-id-123",
  "bank_id":"bank-id-123",
  "name":"Branch by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"String",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":10.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"PDDL",
      "name":"Open Data Commons Public Domain Dedication and License "
    }
  },
  "lobby":{
    "monday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "tuesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "wednesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "thursday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "friday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "saturday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "sunday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }]
  },
  "drive_up":{
    "monday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "tuesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "wednesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "thursday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "friday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "saturday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "sunday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }
  },
  "branch_routing":{
    "scheme":"OBP",
    "address":"123abc"
  },
  "is_accessible":"true",
  "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
  "branch_type":"Full service store",
  "more_info":"short walk to the lake from here",
  "phone_number":"+381631954907"
}
								
							

• CanCreateBranch - Please login to request this Role
• CanCreateBranchAtAnyBank - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• CanDeleteBranch - Please login to request this Role
• CanDeleteBranchAtAnyBank - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
• OBP-50000: Unknown Error.

								
									
{
  "id":"branch-id-123",
  "bank_id":"bank-id-123",
  "name":"Branch by the Lake",
  "address":{
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"String",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE"
  },
  "location":{
    "latitude":10.0,
    "longitude":10.0
  },
  "meta":{
    "license":{
      "id":"PDDL",
      "name":"Open Data Commons Public Domain Dedication and License "
    }
  },
  "lobby":{
    "monday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "tuesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "wednesday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "thursday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "friday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "saturday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }],
    "sunday":[{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }]
  },
  "drive_up":{
    "monday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "tuesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "wednesday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "thursday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "friday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "saturday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    },
    "sunday":{
      "opening_time":"10:00",
      "closing_time":"18:00"
    }
  },
  "branch_routing":{
    "scheme":"OBP",
    "address":"123abc"
  },
  "is_accessible":"true",
  "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
  "branch_type":"Full service store",
  "more_info":"short walk to the lake from here",
  "phone_number":"+381631954907"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• License may not be set. meta.license.id and eta.license.name can not be empty
• OBP-50000: Unknown Error.

								
									
{
  "branches":[{
    "id":"branch-id-123",
    "bank_id":"bank-id-123",
    "name":"Branch by the Lake",
    "address":{
      "line_1":"No 1 the Road",
      "line_2":"The Place",
      "line_3":"The Hill",
      "city":"Berlin",
      "county":"String",
      "state":"Brandenburg",
      "postcode":"13359",
      "country_code":"DE"
    },
    "location":{
      "latitude":10.0,
      "longitude":10.0
    },
    "meta":{
      "license":{
        "id":"PDDL",
        "name":"Open Data Commons Public Domain Dedication and License "
      }
    },
    "lobby":{
      "monday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "tuesday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "wednesday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "thursday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "friday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "saturday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }],
      "sunday":[{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }]
    },
    "drive_up":{
      "monday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "tuesday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "wednesday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "thursday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "friday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "saturday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      },
      "sunday":{
        "opening_time":"10:00",
        "closing_time":"18:00"
      }
    },
    "branch_routing":{
      "scheme":"OBP",
      "address":"123abc"
    },
    "is_accessible":"true",
    "accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
    "branch_type":"Full service store",
    "more_info":"short walk to the lake from here",
    "phone_number":"+381631954907"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• No branches available. License may not be set.
• OBP-50000: Unknown Error.

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "name":"String",
  "address":{
    "line_1":"Osloer Straße 16/17",
    "line_2":"Wedding",
    "line_3":"",
    "city":"Berlin",
    "state":"Berlin Brandenburg",
    "postcode":"13359",
    "country":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "lobby":{
    "hours":"5"
  },
  "drive_up":{
    "hours":"5"
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  },
  "branch_routing":{
    "scheme":"BranchNumber",
    "address":"678"
  }
}
								
							

• CanCreateBranch - Please login to request this Role

• 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-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
• OBP-50000: Unknown Error.

								
									
{
  "bank_id":"gh.29.uk",
  "bank_card_number":"String",
  "name_on_card":"String",
  "issue_number":"String",
  "serial_number":"String",
  "valid_from_date":"2017-09-19T00:00:00Z",
  "expires_date":"2017-09-19T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"String",
  "networks":["String"],
  "allows":["String"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.uk.db"
  },
  "replacement":{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"2017-09-19T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"2017-09-19T00:00:00Z",
  "posted":"2017-09-19T00:00:00Z"
}
								
							

• CanCreateCardsForBank - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10015: Allowed values are:
• OBP-50000: Unknown Error.

								
									
{
  "cards":[{
    "bank_id":"gh.29.uk",
    "bank_card_number":"String",
    "name_on_card":"String",
    "issue_number":"String",
    "serial_number":"String",
    "valid_from_date":"2017-09-19T00:00:00Z",
    "expires_date":"2017-09-19T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"String",
    "networks":["String"],
    "allows":["String"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.uk.db"
    },
    "replacement":{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"2017-09-19T00:00:00Z",
    "posted":"2017-09-19T00:00:00Z"
  }]
}
								
							

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

								
									
{
  "cards":[{
    "bank_id":"gh.29.uk",
    "bank_card_number":"String",
    "name_on_card":"String",
    "issue_number":"String",
    "serial_number":"String",
    "valid_from_date":"2017-09-19T00:00:00Z",
    "expires_date":"2017-09-19T00:00:00Z",
    "enabled":true,
    "cancelled":true,
    "on_hot_list":true,
    "technology":"String",
    "networks":["String"],
    "allows":["String"],
    "account":{
      "id":"123",
      "label":"OBP",
      "views_available":[{
        "id":"123",
        "short_name":"short_name",
        "description":"description",
        "is_public":true,
        "alias":"None",
        "hide_metadata_if_alias_used":true,
        "can_add_comment":true,
        "can_add_corporate_location":true,
        "can_add_image":true,
        "can_add_image_url":true,
        "can_add_more_info":true,
        "can_add_open_corporates_url":true,
        "can_add_physical_location":true,
        "can_add_private_alias":true,
        "can_add_public_alias":true,
        "can_add_tag":true,
        "can_add_url":true,
        "can_add_where_tag":true,
        "can_delete_comment":true,
        "can_delete_corporate_location":true,
        "can_delete_image":true,
        "can_delete_physical_location":true,
        "can_delete_tag":true,
        "can_delete_where_tag":true,
        "can_edit_owner_comment":true,
        "can_see_bank_account_balance":true,
        "can_see_bank_account_bank_name":true,
        "can_see_bank_account_currency":true,
        "can_see_bank_account_iban":true,
        "can_see_bank_account_label":true,
        "can_see_bank_account_national_identifier":true,
        "can_see_bank_account_number":true,
        "can_see_bank_account_owners":true,
        "can_see_bank_account_swift_bic":true,
        "can_see_bank_account_type":true,
        "can_see_comments":true,
        "can_see_corporate_location":true,
        "can_see_image_url":true,
        "can_see_images":true,
        "can_see_more_info":true,
        "can_see_open_corporates_url":true,
        "can_see_other_account_bank_name":true,
        "can_see_other_account_iban":true,
        "can_see_other_account_kind":true,
        "can_see_other_account_metadata":true,
        "can_see_other_account_national_identifier":true,
        "can_see_other_account_number":true,
        "can_see_other_account_swift_bic":true,
        "can_see_owner_comment":true,
        "can_see_physical_location":true,
        "can_see_private_alias":true,
        "can_see_public_alias":true,
        "can_see_tags":true,
        "can_see_transaction_amount":true,
        "can_see_transaction_balance":true,
        "can_see_transaction_currency":true,
        "can_see_transaction_description":true,
        "can_see_transaction_finish_date":true,
        "can_see_transaction_metadata":true,
        "can_see_transaction_other_bank_account":true,
        "can_see_transaction_start_date":true,
        "can_see_transaction_this_bank_account":true,
        "can_see_transaction_type":true,
        "can_see_url":true,
        "can_see_where_tag":true
      }],
      "bank_id":"gh.uk.db"
    },
    "replacement":{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"RENEW"
    },
    "pin_reset":[{
      "requested_date":"2017-09-19T00:00:00Z",
      "reason_requested":"FORGOT"
    }],
    "collected":"2017-09-19T00:00:00Z",
    "posted":"2017-09-19T00:00:00Z"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "cards":[{
    "card_type":"5",
    "card_description":"good",
    "use_type":"3"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-50212: Connector did not return the set of status of credit card.
• OBP-50000: Unknown Error.

								
									
{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"INITIATED"
}
								
							

• 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-50200: Connector cannot return the data we requested.
• OBP-50000: Unknown Error.

								
									
{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"INITIATED"
}
								
							

• 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-50200: Connector cannot return the data we requested.
• OBP-50000: Unknown Error.

								
									
{
  "consents":[{
    "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
    "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
    "status":"INITIATED"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"INITIATED"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "enabled":false
}
								
							

• CanEnableConsumers - Please login to request this Role
• CanDisableConsumers - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "per_second_call_limit":"-1",
  "per_minute_call_limit":"-1",
  "per_hour_call_limit":"-1",
  "per_day_call_limit":"-1",
  "per_week_call_limit":"-1",
  "per_month_call_limit":"-1",
  "current_state":{
    "per_second":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_minute":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_hour":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_day":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_week":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_month":{
      "calls_made":-1,
      "reset_in_seconds":-1
    }
  }
}
								
							

• CanSetCallLimits - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
• OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
• OBP-20006: User is missing one or more roles:
• OBP-30023: Cannot update Consumer
• OBP-50000: Unknown Error.

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"contact@tesobe.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"123213",
  "created_by_user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "enabled":true,
  "created":"2017-09-19T00:00:00Z"
}
								
							

• CanGetConsumers - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
• OBP-50000: Unknown Error.

								
									
{
  "list":[{
    "consumer_id":1213,
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"contact@tesobe.com",
    "redirect_url":"www.openbankproject.com",
    "created_by_user_id":"123213",
    "created_by_user":{
      "user_id":"123",
      "email":"contact@tesobe.com",
      "provider_id":"obp",
      "provider":"obp",
      "username":"TESOBE"
    },
    "enabled":true,
    "created":"2017-09-19T00:00:00Z"
  }]
}
								
							

• CanGetConsumers - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"contact@tesobe.com",
    "redirect_url":"www.openbankproject.com",
    "created_by_user":{
      "user_id":"123",
      "email":"contact@tesobe.com",
      "provider_id":"obp",
      "provider":"obp",
      "username":"TESOBE"
    },
    "enabled":true,
    "created":"2017-09-19T00:00:00Z"
  }]
}
								
							

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

								
									
{
  "per_second_call_limit":"-1",
  "per_minute_call_limit":"-1",
  "per_hour_call_limit":"-1",
  "per_day_call_limit":"-1",
  "per_week_call_limit":"-1",
  "per_month_call_limit":"-1"
}
								
							

• CanSetCallLimits - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
• OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
• OBP-20006: User is missing one or more roles:
• OBP-30023: Cannot update Consumer
• OBP-50000: Unknown Error.

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"contact@tesobe.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"123213",
  "created_by_user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "enabled":true,
  "created":"2017-09-19T00:00:00Z"
}
								
							

• CanUpdateConsumerRedirectUrl - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
  "other_bank_routing_scheme":"bankCode",
  "other_bank_routing_address":"10",
  "other_branch_routing_scheme":"branchNumber",
  "other_branch_routing_address":"10010",
  "other_account_routing_scheme":"accountNumber",
  "other_account_routing_address":"7987987-2348987-234234",
  "other_account_secondary_routing_scheme":"accountId",
  "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"OBP",
        "username":"OBP"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"OBP",
        "username":"OBP"
      }
    },
    "private_alias":"String"
  }
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
• OBP-50000: Unknown Error.

								
									
{
  "counterparties":[{
    "name":"CounterpartyName",
    "description":"My landlord",
    "created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
    "this_bank_id":"gh.29.uk",
    "this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "this_view_id":"owner",
    "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
    "other_bank_routing_scheme":"bankCode",
    "other_bank_routing_address":"10",
    "other_branch_routing_scheme":"branchNumber",
    "other_branch_routing_address":"10010",
    "other_account_routing_scheme":"accountNumber",
    "other_account_routing_address":"7987987-2348987-234234",
    "other_account_secondary_routing_scheme":"accountId",
    "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "is_beneficiary":true,
    "bespoke":[{
      "key":"englishName",
      "value":"english Name"
    }]
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-30022: The current view does not have the permission:
• OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
• OBP-50000: Unknown Error.

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
  "other_bank_routing_scheme":"bankCode",
  "other_bank_routing_address":"10",
  "other_branch_routing_scheme":"branchNumber",
  "other_branch_routing_address":"10010",
  "other_account_routing_scheme":"accountNumber",
  "other_account_routing_address":"7987987-2348987-234234",
  "other_account_secondary_routing_scheme":"accountId",
  "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"OBP",
        "username":"OBP"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"OBP",
        "username":"OBP"
      }
    },
    "private_alias":"String"
  }
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "holder":{
    "name":"OBP",
    "is_alias":true
  },
  "bank_routing":{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "metadata":{
    "public_alias":"NONE",
    "private_alias":"NONE",
    "more_info":"www.openbankproject.com",
    "URL":"www.openbankproject.com",
    "image_URL":"www.openbankproject.com",
    "open_corporates_URL":"www.openbankproject.com",
    "corporate_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"OBP",
        "display_name":"OBP"
      }
    },
    "physical_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"OBP",
        "display_name":"OBP"
      }
    }
  }
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50200: Connector cannot return the data we requested.
• OBP-50000: Unknown Error.

								
									
{
  "other_accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "holder":{
      "name":"OBP",
      "is_alias":true
    },
    "bank_routing":{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "metadata":{
      "public_alias":"NONE",
      "private_alias":"NONE",
      "more_info":"www.openbankproject.com",
      "URL":"www.openbankproject.com",
      "image_URL":"www.openbankproject.com",
      "open_corporates_URL":"www.openbankproject.com",
      "corporate_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      },
      "physical_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }
    }
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• OBP-50200: Connector cannot return the data we requested.
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• the view does not allow adding a corporate location
• Coordinates not possible
• Corporate Location cannot be deleted
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-30022: The current view does not have the permission:
• the view ownerdoes not allow adding more info
• More Info cannot be added
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow adding an open corporate url
• URL cannot be added
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow adding an image url
• URL cannot be added
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow adding a physical location
• Coordinates not possible
• Physical Location cannot be added
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.
• the view does not allow metadata access
• the view does not allow adding a public alias
• Alias cannot be added
• public alias added

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow adding a url
• URL cannot be added
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow adding a private alias
• Alias cannot be added
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• Corporate Location cannot be deleted
• Delete not completed
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• the view does not allow deleting an open corporate url
• URL cannot be deleted
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-30022: The current view does not have the permission:
• Physical Location cannot be deleted
• Delete not completed
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• the view does not allow deleting the private alias
• Alias cannot be deleted
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• the view does not allow deleting the public alias
• Alias cannot be deleted
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• the view does not allow deleting more info
• More Info cannot be deleted
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• the view does not allow deleting a url
• URL cannot be deleted
• OBP-50000: Unknown Error.

								
									
{
  "public_alias":"NONE",
  "private_alias":"NONE",
  "more_info":"www.openbankproject.com",
  "URL":"www.openbankproject.com",
  "image_URL":"www.openbankproject.com",
  "open_corporates_URL":"www.openbankproject.com",
  "corporate_location":{
    "latitude":1.231,
    "longitude":1.231,
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"OBP",
      "display_name":"OBP"
    }
  },
  "physical_location":{
    "latitude":1.231,
    "longitude":1.231,
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"OBP",
      "display_name":"OBP"
    }
  }
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.
• the view does not allow metadata access

								
									
{
  "alias":"String"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• the view does not allow metadata access
• the view does not allow private alias access
• OBP-50000: Unknown Error.

								
									
{
  "alias":"String"
}
								
							

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-50000: Unknown Error.
• the view does not allow metadata access
• the view does not allow public alias access

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow updating a corporate location
• Coordinates not possible
• Corporate Location cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow updating an image url
• URL cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow updating more info
• More Info cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow updating a physical location
• Coordinates not possible
• Physical Location cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow updating the private alias
• Alias cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• the view does not allow metadata access
• the view does not allow updating an open corporate url
• URL cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-20001: User not logged in. Authentication is required!
• the view does not allow metadata access
• the view does not allow updating the public alias
• Alias cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
• OBP-10001: Incorrect json format.
• OBP-30022: The current view does not have the permission:
• OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
• URL cannot be updated
• OBP-50000: Unknown Error.

								
									
{
  "customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "customer_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "line_1":"No 1 the Road",
  "line_2":"The Place",
  "line_3":"The Hill",
  "city":"Berlin",
  "county":"",
  "state":"Brandenburg",
  "postcode":"13359",
  "country_code":"DE",
  "tags":["mailing","home"],
  "status":"OK",
  "insert_date":"2017-09-19T00:00:00Z"
}
								
							

• CanCreateCustomerAddress - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

• CanAddSocialMediaHandle - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-20006: User is missing one or more roles:
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-50000: Unknown Error.

								
									
{
  "tax_residence":[{
    "domain":"Enter some domain",
    "tax_number":"Enter some number",
    "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
  }]
}
								
							

• CanCreateTaxResidence - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

								
									
{
  "execution_time":"String",
  "execution_date":"String",
  "token":"String",
  "short_reference":"String"
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "bank_id":"bankid1234",
  "customer_id":"123",
  "customer_number":"123",
  "legal_name":"legal_name",
  "mobile_phone_number":"123",
  "email":"contact@tesobe.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"2017-09-19T00:00:00Z",
  "relationship_status":"123",
  "dependants":123,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"123",
  "employment_status":"123",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"12314",
  "nameSuffix":"Sr"
}
								
							

• CanCreateCustomer - Please login to request this Role
• CanCreateUserCustomerLink - Please login to request this Role
• CanCreateCustomerAtAnyBank - Please login to request this Role
• CanCreateUserCustomerLinkAtAnyBank - Please login to request this Role

• 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.

								
									
{
  "user_customer_link_id":"String",
  "customer_id":"String",
  "user_id":"String",
  "date_inserted":"2017-09-19T00:00:00Z",
  "is_active":true
}
								
							

• CanCreateUserCustomerLink - Please login to request this Role
• CanCreateUserCustomerLinkAtAnyBank - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-10001: Incorrect json format.
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-20006: User is missing one or more roles:
• OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
• OBP-30025: Could not create user_customer_links
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• CanDeleteCustomerAddress - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "crm_events":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "bank_id":"gh.29.uk",
    "customer_name":"String",
    "customer_number":"String",
    "category":"String",
    "detail":"String",
    "channel":"String",
    "scheduled_date":"2017-09-19T00:00:00Z",
    "actual_date":"2017-09-19T00:00:00Z",
    "result":"String"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• No CRM Events available.
• OBP-50000: Unknown Error.

								
									
{
  "rank_amount_1":"String",
  "nominal_interest_1":"String",
  "rank_amount_2":"String",
  "nominal_interest_2":"String"
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "rank_amount_1":"String",
  "nominal_interest_1":"String",
  "rank_amount_2":"String",
  "nominal_interest_2":"String"
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "addresses":[{
    "customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "customer_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE",
    "tags":["mailing","home"],
    "status":"OK",
    "insert_date":"2017-09-19T00:00:00Z"
  }]
}
								
							

• CanGetCustomerAddress - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "checks":[{
    "customer_number":"PlaceholderString",
    "type":"PlaceholderString",
    "handle":"PlaceholderString",
    "date_added":"2017-09-19T00:00:00Z",
    "date_activated":"2017-09-19T00:00:00Z"
  }]
}
								
							

• CanGetSocialMediaHandles - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-50000: Unknown Error.

								
									
{
  "bank_id":"bankid1234",
  "customer_id":"123",
  "customer_number":"123",
  "legal_name":"legal_name",
  "mobile_phone_number":"123",
  "email":"contact@tesobe.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"2017-09-19T00:00:00Z",
  "relationship_status":"123",
  "dependants":123,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"123",
  "employment_status":"123",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"12314",
  "nameSuffix":"Sr"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.

								
									
{
  "bank_id":"bankid1234",
  "customer_id":"123",
  "customer_number":"123",
  "legal_name":"legal_name",
  "mobile_phone_number":"123",
  "email":"contact@tesobe.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"2017-09-19T00:00:00Z",
  "relationship_status":"123",
  "dependants":123,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"123",
  "employment_status":"123",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"12314",
  "nameSuffix":"Sr"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.

								
									
{
  "bank_id":"bankid1234",
  "customer_id":"123",
  "customer_number":"123",
  "legal_name":"legal_name",
  "mobile_phone_number":"123",
  "email":"contact@tesobe.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"19900101",
  "relationship_status":"123",
  "dependants":123,
  "dob_of_dependants":["19900101"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"123",
  "employment_status":"123",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"12314",
  "nameSuffix":"Sr"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.

								
									
{
  "bank_id":"bankid1234",
  "customer_id":"123",
  "customer_number":"123",
  "legal_name":"legal_name",
  "mobile_phone_number":"123",
  "email":"contact@tesobe.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"2017-09-19T00:00:00Z",
  "relationship_status":"123",
  "dependants":123,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"123",
  "employment_status":"123",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30008: User Customer Link not found by USER_ID
• OBP-30008: User Customer Link not found by USER_ID
• OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
• OBP-50000: Unknown Error.

								
									
{
  "tax_residence":[{
    "domain":"Enter some domain",
    "tax_number":"Enter some number",
    "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "customer_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "line_1":"No 1 the Road",
  "line_2":"The Place",
  "line_3":"The Hill",
  "city":"Berlin",
  "county":"",
  "state":"Brandenburg",
  "postcode":"13359",
  "country_code":"DE",
  "tags":["mailing","home"],
  "status":"OK",
  "insert_date":"2017-09-19T00:00:00Z"
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

								
									
{
  "meeting_id":"UUID-String",
  "provider_id":"String, eg: tokbox",
  "purpose_id":"String, eg: onboarding",
  "bank_id":"gh.29.uk",
  "present":{
    "staff_user_id":"String",
    "customer_user_id":"String"
  },
  "keys":{
    "session_id":"String",
    "staff_token":"String",
    "customer_token":"String"
  },
  "when":"2017-09-19T00:00:00Z",
  "creator":{
    "name":"Simon ",
    "mobile_phone":"+44 07972 444 876",
    "email_address":"contact@tesobe.com"
  },
  "invitees":[{
    "contact_details":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"contact@tesobe.com"
    },
    "status":"String, eg: Good"
  }]
}
								
							

• 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-50000: Unknown Error.

								
									
{
  "meeting_id":"UUID-String",
  "provider_id":"String, eg: tokbox",
  "purpose_id":"String, eg: onboarding",
  "bank_id":"gh.29.uk",
  "present":{
    "staff_user_id":"String",
    "customer_user_id":"String"
  },
  "keys":{
    "session_id":"String",
    "staff_token":"String",
    "customer_token":"String"
  },
  "when":"2017-09-19T00:00:00Z",
  "creator":{
    "name":"Simon ",
    "mobile_phone":"+44 07972 444 876",
    "email_address":"contact@tesobe.com"
  },
  "invitees":[{
    "contact_details":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"contact@tesobe.com"
    },
    "status":"String, eg: Good"
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30104: Meeting not found.
• OBP-50000: Unknown Error.

								
									
{
  "meetings":[{
    "meeting_id":"UUID-String",
    "provider_id":"String, eg: tokbox",
    "purpose_id":"String, eg: onboarding",
    "bank_id":"gh.29.uk",
    "present":{
      "staff_user_id":"String",
      "customer_user_id":"String"
    },
    "keys":{
      "session_id":"String",
      "staff_token":"String",
      "customer_token":"String"
    },
    "when":"2017-09-19T00:00:00Z",
    "creator":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"contact@tesobe.com"
    },
    "invitees":[{
      "contact_details":{
        "name":"Simon ",
        "mobile_phone":"+44 07972 444 876",
        "email_address":"contact@tesobe.com"
      },
      "status":"String, eg: Good"
    }]
  }]
}
								
							

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-50000: Unknown Error.

								
									
{
  "success":"Success"
}
								
							

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

								
									
{
  "messages":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "date":"2017-09-19T00:00:00Z",
    "message":"String",
    "from_department":"String",
    "from_person":"String"
  }]
}
								
							

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

								
									
{
  "jsonString":"{}"
}
								
							

• CanSearchWarehouse - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• CanSearchWarehouseStatistics - Please login to request this Role

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "glossary_items":[{
    "title":"String",
    "description":{
      "markdown":"String",
      "html":"String"
    }
  }]
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "message_docs":[{
    "process":"getAccounts",
    "message_format":"KafkaV2017",
    "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
    "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
    "description":"get Banks",
    "example_outbound_message":{
      "jsonString":"{}"
    },
    "example_inbound_message":{
      "jsonString":"{}"
    },
    "outboundAvroSchema":{
      "jsonString":"{}"
    },
    "inboundAvroSchema":{
      "jsonString":"{}"
    },
    "adapter_implementation":{
      "group":"CORE",
      "suggested_order":3
    }
  }]
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "message_docs":[{
    "process":"getAccounts",
    "message_format":"KafkaV2017",
    "outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
    "inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
    "description":"get Banks",
    "example_outbound_message":{
      "jsonString":"{}"
    },
    "example_inbound_message":{
      "jsonString":"{}"
    },
    "outboundAvroSchema":{
      "jsonString":"{}"
    },
    "inboundAvroSchema":{
      "jsonString":"{}"
    },
    "adapter_implementation":{
      "group":"CORE",
      "suggested_order":3
    }
  }]
}
								
							

• OBP-50000: Unknown Error.

								
									
{
  "jsonString":"{}"
}
								
							

• OBP-50000: Unknown Error.