API Explorer

v4.0.0 (490 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Insurance Policy

Create new Insurance Policy.

Which insurance policies the customer already has.

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":"InsurancePolicy"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"f1ac8436-fca6-467a-988a-1a0ca3e27112", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_InsurancePolicy - 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_createInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_createInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Delete Insurance Policy by id

Delete Insurance Policy 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":"InsurancePolicy"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"d420e5b3-3355-4042-bd55-8134a6acca76", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_InsurancePolicy - 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_deleteInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_deleteInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Get Insurance Policy List

Get Insurance Policy List.

Which insurance policies the customer already has.

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":"InsurancePolicy"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /InsurancePolicy?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_policy_list":[{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"7c63ca36-9c99-43a3-a65d-1253b0600bda", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_InsurancePolicy - 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_getInsurancePolicyList, operation_id: OBPv4.0.0-dynamicEntity_getInsurancePolicyList Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Get Insurance Policy by id

Get Insurance Policy by id.

Which insurance policies the customer already has.

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":"InsurancePolicy"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"37709da6-fada-4dea-b8e0-0fc720451ca0", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_InsurancePolicy - 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_getSingleInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_getSingleInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,

Update Insurance Policy

Update Insurance Policy.

Which insurance policies the customer already has.

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":"InsurancePolicy"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "insurance_policy":{ "insurancePolicyId":"da010507-0889-4b8a-9834-b671af239cb5", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_InsurancePolicy - 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_updateInsurancePolicy, operation_id: OBPv4.0.0-dynamicEntity_updateInsurancePolicy Tags: _InsurancePolicy, New-Style, Dynamic-Entity, Dynamic,