{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v4.0.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v4.0.0/banks/{BANK_ID}/customer/{CUSTOMER_ID}/messages":{"post":{"tags":["Customer-Message","Customer","Person"],"summary":"Create Customer Message","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Create a message for the customer specified by CUSTOMER_ID
Authentication is Mandatory
","operationId":"addCustomerMessage","parameters":[{"in":"body","name":"body","description":"AddCustomerMessageJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AddCustomerMessageJson"}},{"in":"path","name":"CUSTOMER_ID","description":"The customer id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/SuccessMessage"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/customers":{"post":{"tags":["Customer","Person"],"summary":"Create Customer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
Dates need to be in the format 2013-01-21T23:08:00Z
Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.
Authentication is Mandatory
","operationId":"createCustomer","parameters":[{"in":"body","name":"body","description":"PostCustomerJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCustomerJsonV310"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/customers/{CUSTOMER_ID}/messages":{"post":{"tags":["Customer-Message","Customer","Person"],"summary":"Create Customer Message","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a message for the customer specified by CUSTOMER_ID
Authentication is Mandatory