right logo image
right logo image
Log on
⯆

API Explorer

Log off

v4.0.0 (541 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create new Insurance Premium

Create new Insurance Premium.

Retrive the premium for the customer.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"InsurancePremium"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "insurance_premium":{
    "insurancePremiumId":"341e388f-42b4-4380-ace3-a3bf475f6d9b",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanCreateDynamicEntity_InsurancePremium - 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: OBPv4.0.0, function_name: by dynamicEntity_createInsurancePremium_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_createInsurancePremium_gh.29.uk Tags: _Insurance Premium(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Delete Insurance Premium by id

Delete Insurance Premium by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"InsurancePremium"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "insurance_premium":{
    "insurancePremiumId":"1c4cd593-d08f-4e3a-af6d-a60eb2c1e70a",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanDeleteDynamicEntity_InsurancePremium - 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: OBPv4.0.0, function_name: by dynamicEntity_deleteInsurancePremium_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_deleteInsurancePremium_gh.29.uk Tags: _Insurance Premium(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Get Insurance Premium List

Get Insurance Premium List.

Retrive the premium for the customer.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"InsurancePremium"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /InsurancePremium?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "insurance_premium_list":[{
    "bank-id":"gh.29.uk",
    "insurance_premium":{
      "insurancePremiumId":"fa10d533-8193-4194-b4dc-84244efe0d75",
      "name":"James Brown",
      "number":698761728
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_InsurancePremium - 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 dynamicEntity_getInsurancePremiumList_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_getInsurancePremiumList_gh.29.uk Tags: _Insurance Premium(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Get Insurance Premium by id

Get Insurance Premium by id.

Retrive the premium for the customer.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"InsurancePremium"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "insurance_premium":{
    "insurancePremiumId":"b040a944-f6b4-44d4-a4e3-247662b3146a",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanGetDynamicEntity_InsurancePremium - 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 dynamicEntity_getSingleInsurancePremium_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_getSingleInsurancePremium_gh.29.uk Tags: _Insurance Premium(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,

Update Insurance Premium

Update Insurance Premium.

Retrive the premium for the customer.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"InsurancePremium"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "insurance_premium":{
    "insurancePremiumId":"5de2a53d-cc6c-4096-83d2-dcb78872aaee",
    "name":"James Brown",
    "number":698761728
  }
}
Required Roles:
  • CanUpdateDynamicEntity_InsurancePremium - 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: OBPv4.0.0, function_name: by dynamicEntity_updateInsurancePremium_gh.29.uk, operation_id: OBPv4.0.0-dynamicEntity_updateInsurancePremium_gh.29.uk Tags: _Insurance Premium(gh.29.uk), New-Style, Dynamic-Entity, Dynamic,