right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (592 APIs)

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

Create new My Risk Check

Create new My Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_createMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Create new Risk Check

Create new Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanCreateDynamicEntity_risk_check - 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_createrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_createrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Delete My Risk Check by id

Delete My Risk Check 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":"risk_check"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
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: OBPv4.0.0, function_name: by dynamicEntity_deleteMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_deleteMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Delete Risk Check by id

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_risk_check - 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_deleterisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_deleterisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get My Risk Check List

Get My Risk Check List.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /risk_check?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",
  "risk_check_list":[{
    "bank-id":"gh.29.uk",
    "risk_check":{
      "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
      "check_type":"Real Estate Evaluation",
      "employee_number":698761728,
      "passed":true,
      "day":"2023-12-16"
    }
  }]
}
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: OBPv4.0.0, function_name: by dynamicEntity_getMyrisk_checkList_tobank, operation_id: OBPv4.0.0-dynamicEntity_getMyrisk_checkList_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get My Risk Check by id

Get My Risk Check by id.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
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: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get Risk Check List

Get Risk Check List.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /risk_check?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",
  "risk_check_list":[{
    "bank-id":"gh.29.uk",
    "risk_check":{
      "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
      "check_type":"Real Estate Evaluation",
      "employee_number":698761728,
      "passed":true,
      "day":"2023-12-16"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_risk_check - 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_getrisk_checkList_tobank, operation_id: OBPv4.0.0-dynamicEntity_getrisk_checkList_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Get Risk Check by id

Get Risk Check by id.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanGetDynamicEntity_risk_check - 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_getSinglerisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_getSinglerisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Update My Risk Check

Update My Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_risk_check - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyrisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_updateMyrisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,

Update Risk Check

Update Risk Check.

Random risk checks performed by bank employee

Property List:

  • customer: OBP Customer ID
  • check_type: Check if the real value of customer real estate matches the value
  • employee_number: Number of Employee doing the check
  • passed: Did risk check passed
  • day: Day the check was performed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "risk_check":{
    "risk_checkId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer":"6ccb96f6-c404-11ed-a94e-54e1adfac5b1",
    "check_type":"Real Estate Evaluation",
    "employee_number":698761728,
    "passed":true,
    "day":"2023-12-16"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_risk_check - 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_updaterisk_check_tobank, operation_id: OBPv4.0.0-dynamicEntity_updaterisk_check_tobank Tags: _Risk Check(tobank), Dynamic-Entity, Dynamic,