right logo image
right logo image
Log on

v5.0.0 (23 APIs)

API Host: https://obp-apisandbox.bancohipotecario.com.sv
Bank
Accounts
Views
Counterparties
Transactions

Create Account Application

Create Account Application

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"1234",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv3.1.0, function_name: by createAccountApplication, operation_id: OBPv3.1.0-createAccountApplication Tags: Account-Application, Account, New-Style,

Update Account Application Status

Update an Account Application status

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response

								
									
{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"1234",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateAccountApplicationStatus, operation_id: OBPv3.1.0-updateAccountApplicationStatus Tags: Account-Application, Account, New-Style,

Create Bank

Create a new bank (Authenticated access).

The user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
Thus the User can manage the bank they create and assign Roles to other Users.

Only SANDBOX mode
The settlement accounts are created specified by the bank in the POST body.
Name and account id are created in accordance to the next rules:
- Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)
- Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)

Authentication is Mandatory

JSON request body fields:

  • name: ACCOUNT_MANAGEMENT_FEE

  • value: 5987953

JSON response body fields:

  • name: ACCOUNT_MANAGEMENT_FEE

  • value: 5987953

Typical Successful Response

								
									
{
  "id":"gh.29.uk",
  "short_name":"short_name ",
  "full_name":"full_name",
  "logo":"logo",
  "website":"www.openbankproject.com",
  "bank_routings":[{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  }],
  "attributes":[{
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "value":"5987953"
  }]
}
Required Roles:
  • CanCreateBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createBank, operation_id: OBPv4.0.0-createBank Tags: Bank, New-Style,

Add Corporate Location to Counterparty

Add the geolocation of the counterparty's registered address

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response

								
									
{
  "success":"Success"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyCorporateLocation, operation_id: OBPv1.2.1-addCounterpartyCorporateLocation Tags: Counterparty-Metadata, Counterparty,

Add Counterparty More Info

Add a description of the counter party from the perpestive of the account e.g. My dentist

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response

								
									
{
  "success":"Success"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyMoreInfo, operation_id: OBPv1.2.1-addCounterpartyMoreInfo Tags: Counterparty-Metadata, Counterparty, New-Style,

Create Customer

The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
Dates need to be in the format 2013-01-21T23:08:00Z

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

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"2017-09-19T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"0"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanCreateCustomer - Please login to request this Role
  • CanCreateCustomerAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
  • OBP-30024: Could not create Consumer
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv3.1.0, function_name: by createCustomer, operation_id: OBPv3.1.0-createCustomer Tags: Customer, Person, New-Style,

Create User Customer Link

Link a User to a Customer

Authentication is Mandatory

CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.

URL Parameters:

JSON request body fields:

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

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

JSON response body fields:

Typical Successful Response

								
									
{
  "user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "date_inserted":"2017-09-19T00:00:00Z",
  "is_active":true
}
Required Roles:
  • CanCreateUserCustomerLink - Please login to request this Role
  • CanCreateUserCustomerLinkAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-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.
Connector Methods:
Version: OBPv2.0.0, function_name: by createUserCustomerLinks, operation_id: OBPv2.0.0-createUserCustomerLinks Tags: Customer, User,

Get Customers for Current User

Gets all Customers that are linked to a User.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response

								
									
{
  "customers":[{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"19900101",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["19900101"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr",
    "customer_attributes":[{
      "customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "name":"SPECIAL_TAX_NUMBER",
      "type":"STRING",
      "value":"123456789"
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getCustomersForUser, operation_id: OBPv3.0.0-getCustomersForUser Tags: Customer, User, New-Style,

Get Tax Residences of Customer

Get the Tax Residences of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response

								
									
{
  "tax_residence":[{
    "domain":"Enter some domain",
    "tax_number":"Enter some number",
    "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getTaxResidence, operation_id: OBPv3.1.0-getTaxResidence Tags: Customer, KYC, New-Style,

Update the credit limit of a Customer

Update the credit limit of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"2017-09-19T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"0"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerCreditLimit - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerCreditLimit, operation_id: OBPv3.1.0-updateCustomerCreditLimit Tags: Customer, New-Style,

Update the credit rating and source of a Customer

Update the credit rating and source of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"2017-09-19T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"0"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerCreditRatingAndSource - Please login to request this Role
  • CanUpdateCustomerCreditRatingAndSourceAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerCreditRatingAndSource, operation_id: OBPv3.1.0-updateCustomerCreditRatingAndSource Tags: Customer, New-Style,

Create Bank Level Dynamic Entity

Create a Bank Level DynamicEntity.

Authentication is Mandatory

Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

The DATE_WITH_DAY format is: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {
    "type": "reference:OBP_API",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField1": {
    "type": "reference:FooBar",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField2": {
    "type": "reference:OBP_Activity",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField3": {
    "type": "reference:OBP_Reena",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField4": {
    "type": "reference:Bank",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField5": {
    "type": "reference:Consumer",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField6": {
    "type": "reference:Customer",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField7": {
    "type": "reference:MethodRouting",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField8": {
    "type": "reference:DynamicEntity",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField9": {
    "type": "reference:TransactionRequest",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField10": {
    "type": "reference:ProductAttribute",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField11": {
    "type": "reference:AccountAttribute",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField12": {
    "type": "reference:TransactionAttribute",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField13": {
    "type": "reference:CustomerAttribute",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField14": {
    "type": "reference:AccountApplication",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField15": {
    "type": "reference:CardAttribute",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField16": {
    "type": "reference:Counterparty",
    "example": "388357bd-44c0-45a1-9727-2b2797001c2c"
}

"someField17": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=388357bd-44c0-45a1-9727-2b2797001c2c&branchId=95fc3912-7cdd-4aa1-ade2-2cc462dc3df6"
}

"someField18": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=388357bd-44c0-45a1-9727-2b2797001c2c&atmId=95fc3912-7cdd-4aa1-ade2-2cc462dc3df6"
}

"someField19": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=388357bd-44c0-45a1-9727-2b2797001c2c&accountId=95fc3912-7cdd-4aa1-ade2-2cc462dc3df6"
}

"someField20": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=388357bd-44c0-45a1-9727-2b2797001c2c&productCode=95fc3912-7cdd-4aa1-ade2-2cc462dc3df6"
}

"someField21": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=388357bd-44c0-45a1-9727-2b2797001c2c&cardId=95fc3912-7cdd-4aa1-ade2-2cc462dc3df6"
}

"someField22": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=388357bd-44c0-45a1-9727-2b2797001c2c&accountId=95fc3912-7cdd-4aa1-ade2-2cc462dc3df6&transactionId=d25f0d9f-4d10-4995-9fe3-747f78126cbc"
}

"someField23": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=388357bd-44c0-45a1-9727-2b2797001c2c&accountId=95fc3912-7cdd-4aa1-ade2-2cc462dc3df6&counterpartyId=d25f0d9f-4d10-4995-9fe3-747f78126cbc"
}

Note: BankId filed is optional,
if you add it, the entity will be the Bank level.
if you omit it, the entity will be the System level.

Typical Successful Response

								
									
{
  "bankId":"gh.29.uk",
  "FooBar":{
    "description":"description of this entity, can be markdown text.",
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "minLength":3,
        "maxLength":20,
        "example":"James Brown",
        "description":"description of **name** field, can be markdown text."
      },
      "number":{
        "type":"integer",
        "example":698761728,
        "description":"description of **number** field, can be markdown text."
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
}
Required Roles:
  • CanCreateBankLevelDynamicEntity - Please login to request this Role
  • CanCreateDynamicEntity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by createBankLevelDynamicEntity, operation_id: OBPv4.0.0-createBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, API, New-Style,

Get Bank Level Dynamic Entities

Get all the bank level Dynamic Entities for one bank.

Authentication is Mandatory

Typical Successful Response

								
									
{
  "dynamic_entities":[{
    "bankId":"gh.29.uk",
    "FooBar":{
      "description":"description of this entity, can be markdown text.",
      "required":["name"],
      "properties":{
        "name":{
          "type":"string",
          "minLength":3,
          "maxLength":20,
          "example":"James Brown",
          "description":"description of **name** field, can be markdown text."
        },
        "number":{
          "type":"integer",
          "example":698761728,
          "description":"description of **number** field, can be markdown text."
        }
      }
    },
    "dynamicEntityId":"dynamic-entity-id",
    "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
  }]
}
Required Roles:
  • CanGetBankLevelDynamicEntities - Please login to request this Role
  • CanGetDynamicEntities - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBankLevelDynamicEntities, operation_id: OBPv4.0.0-getBankLevelDynamicEntities Tags: Dynamic-Entity-Manage, API, New-Style,

Add KYC Document

Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "type":"PlaceholderString",
  "number":"PlaceholderString",
  "issue_date":"2017-09-19T00:00:00Z",
  "issue_place":"PlaceholderString",
  "expiry_date":"2017-09-19T00:00:00Z"
}
Required Roles:
  • CanAddKycDocument - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • Server error: could not add KycDocument
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycDocument, operation_id: OBPv2.0.0-addKycDocument Tags: KYC, Customer, New-Style,

Add KYC Media

Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"PlaceholderString",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "type":"PlaceholderString",
  "url":"PlaceholderString",
  "date":"2017-09-19T00:00:00Z",
  "relates_to_kyc_document_id":"PlaceholderString",
  "relates_to_kyc_check_id":"PlaceholderString"
}
Required Roles:
  • CanAddKycMedia - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-00004: Server error: could not add message
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv2.0.0, function_name: by addKycMedia, operation_id: OBPv2.0.0-addKycMedia Tags: KYC, Customer, New-Style,

Create Product

Create or Update Product for the Bank.

Typical Super Family values / Asset classes are:

Debt
Equity
FX
Commodity
Derivative

Product hiearchy vs Product Collections:

  • You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.

  • You can define a collection (also known as baskets or buckets) of products using Product Collections.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response

								
									
{
  "bank_id":"gh.29.uk",
  "product_code":"1234",
  "parent_product_code":"no-example-provided",
  "name":"no-example-provided",
  "more_info_url":"no-example-provided",
  "terms_and_conditions_url":"no-example-provided",
  "description":"This an optional field. Maximum length is 2000. It can be any characters here.",
  "meta":{
    "license":{
      "id":"ODbL-1.0",
      "name":"Open Database License"
    }
  }
}
Required Roles:
  • CanCreateProduct - Please login to request this Role
  • CanCreateProductAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createProduct, operation_id: OBPv4.0.0-createProduct Tags: Product, New-Style,

Add Asset To A Fund

Add an Asset to an existing fund

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/asset"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{
  "wallets":["string"]
}
Required Roles:
  • CanCreateDynamicEndpoint_FundAsset567 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_asset, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_asset Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add Fund

Create a Fund that serves as a wallet containing assets, addresses, and custody policies. Custody policies for both deposits and withdrawals must exist for a fund. Policies can include multiple custodians, or a single user that self-manages custody. For an individual fund, you can also add whitelisted withdrawal addresses.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{
  "custodygroup_tx":"string",
  "custodygroup_withdraw":"string",
  "fund_id":"string"
}
Required Roles:
  • CanCreateDynamicEndpoint_Fund114 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_fund, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_fund Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add Trusted Party

Add a Trusted Party for the Company. A Trusted Party is a user that can be added as a custodian of a wallet or member of a fund. Qredo network as a Company or User.
When adding a user, they must approve this via their Qredo Signing App.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/trustedparty"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{
  "code":1,
  "msg":"string"
}
Required Roles:
  • CanCreateDynamicEndpoint_TrustedPartyNew113 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_trustedparty, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_trustedparty Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Add Wallet To A Fund

Add a new Wallet to an existing fund. If Custody groups are blank the default fund cutosdy policy will be used

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://play-api.qredo.network/api/v1/p/company/{company_id}/fund/{fund_id}/wallet"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response

								
									
{
  "wallets":["string"]
}
Required Roles:
  • CanCreateDynamicEndpoint_FundWallet103 - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_wallet, operation_id: OBPv4.0.0-dynamicEndpoint_POST_company_COMPANY_ID_fund_FUND_ID_wallet Tags: Qredo Partner & Core Client API, New-Style, Dynamic-Endpoint, Dynamic,

Create User

Creates OBP user.
No authorisation (currently) required.

Mimics current webform to Register.

Requires username(email) and password.

Returns 409 error if username not unique.

May require validation of email address.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"felixsmith@example.com",
  "provider_id":"Chris",
  "provider":"http://127.0.0.1:8080",
  "username":"felixsmith",
  "entitlements":{
    "list":[{
      "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
      "role_name":"CanQueryOtherUser",
      "bank_id":"gh.29.uk"
    }]
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR the length should be > 16 and <= 512.
  • Error occurred during user creation.
  • User with the same username already exists.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by createUser, operation_id: OBPv2.0.0-createUser Tags: User, Onboarding,

Create User Auth Context

Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and
Bank User/Customer.
Authentication is Mandatory

URL Parameters:

  • USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON request body fields:

JSON response body fields:

Typical Successful Response

								
									
{
  "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "time_stamp":"2017-09-19T00:00:00Z"
}
Required Roles:
  • CanCreateUserAuthContext - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv3.1.0, function_name: by createUserAuthContext, operation_id: OBPv3.1.0-createUserAuthContext Tags: User, New-Style,

Create User Auth Context Update Request

Create User Auth Context Update Request.
Authentication is Mandatory

A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.

URL Parameters:

JSON request body fields:

JSON response body fields:

  • key: CustomerNumber

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

  • value: 5987953

Typical Successful Response

								
									
{
  "user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "status":"INITIATED"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createUserAuthContextUpdateRequest, operation_id: OBPv3.1.0-createUserAuthContextUpdateRequest Tags: User, New-Style,