API Explorer

v5.1.0 filtered by tag: Dynamic-Entity (60 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • bank_code: Bank reference code
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "bank_code":"mybank", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_Systemauthority_data_request - 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_createauthority_data_request_, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_ Tags: _Authority Data Request, Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "bank_code":"mybank", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_Systemauthority_data_request - 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_deleteauthority_data_request_, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_ Tags: _Authority Data Request, Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • bank_code: Bank reference code
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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:

								
									
{ "authority_data_request_list":[{ "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "bank_code":"mybank", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_Systemauthority_data_request - 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_getauthority_data_requestList_, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_ Tags: _Authority Data Request, Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • bank_code: Bank reference code
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "bank_code":"mybank", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_Systemauthority_data_request - 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_getSingleauthority_data_request_, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_ Tags: _Authority Data Request, Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • bank_code: Bank reference code
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "bank_code":"mybank", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_Systemauthority_data_request - 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_updateauthority_data_request_, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_ Tags: _Authority Data Request, Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_000202, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_000202 Tags: _Authority Data Request(000202), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_000202, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_000202 Tags: _Authority Data Request(000202), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_000202, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_000202 Tags: _Authority Data Request(000202), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_000202, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_000202 Tags: _Authority Data Request(000202), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_000202, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_000202 Tags: _Authority Data Request(000202), Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_ADOPEM, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_ADOPEM Tags: _Authority Data Request(ADOPEM), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_ADOPEM, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_ADOPEM Tags: _Authority Data Request(ADOPEM), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_ADOPEM, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_ADOPEM Tags: _Authority Data Request(ADOPEM), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_ADOPEM, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_ADOPEM Tags: _Authority Data Request(ADOPEM), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_ADOPEM, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_ADOPEM Tags: _Authority Data Request(ADOPEM), Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_APAP, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_APAP Tags: _Authority Data Request(APAP), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_APAP, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_APAP Tags: _Authority Data Request(APAP), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_APAP, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_APAP Tags: _Authority Data Request(APAP), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_APAP, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_APAP Tags: _Authority Data Request(APAP), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_APAP, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_APAP Tags: _Authority Data Request(APAP), Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_BANRESERVAS, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_BANRESERVAS Tags: _Authority Data Request(BANRESERVAS), Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_BHD_LEON, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_BHD_LEON Tags: _Authority Data Request(BHD LEON), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_BHD_LEON, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_BHD_LEON Tags: _Authority Data Request(BHD LEON), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_BHD_LEON, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_BHD_LEON Tags: _Authority Data Request(BHD LEON), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_BHD_LEON, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_BHD_LEON Tags: _Authority Data Request(BHD LEON), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_BHD_LEON, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_BHD_LEON Tags: _Authority Data Request(BHD LEON), Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_CONFISA, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_CONFISA Tags: _Authority Data Request(CONFISA), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_CONFISA, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_CONFISA Tags: _Authority Data Request(CONFISA), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_CONFISA, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_CONFISA Tags: _Authority Data Request(CONFISA), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_CONFISA, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_CONFISA Tags: _Authority Data Request(CONFISA), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_CONFISA, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_CONFISA Tags: _Authority Data Request(CONFISA), Dynamic-Entity, Dynamic,

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv4.0.0, function_name: by dynamicEntity_createauthority_data_request_POPULAR, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_POPULAR Tags: _Authority Data Request(POPULAR), Dynamic-Entity, Dynamic,

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteauthority_data_request_POPULAR, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_POPULAR Tags: _Authority Data Request(POPULAR), Dynamic-Entity, Dynamic,

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

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

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv4.0.0, function_name: by dynamicEntity_getauthority_data_requestList_POPULAR, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_POPULAR Tags: _Authority Data Request(POPULAR), Dynamic-Entity, Dynamic,

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleauthority_data_request_POPULAR, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_POPULAR Tags: _Authority Data Request(POPULAR), Dynamic-Entity, Dynamic,

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv4.0.0, function_name: by dynamicEntity_updateauthority_data_request_POPULAR, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_POPULAR Tags: _Authority Data Request(POPULAR), Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_SCOTIABANK, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_SCOTIABANK Tags: _Authority Data Request(SCOTIABANK), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_SCOTIABANK, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_SCOTIABANK Tags: _Authority Data Request(SCOTIABANK), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_SCOTIABANK, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_SCOTIABANK Tags: _Authority Data Request(SCOTIABANK), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_SCOTIABANK, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_SCOTIABANK Tags: _Authority Data Request(SCOTIABANK), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_SCOTIABANK, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_SCOTIABANK Tags: _Authority Data Request(SCOTIABANK), Dynamic-Entity, Dynamic,

Create new Authority Data Request

Create new Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanCreateDynamicEntity_authority_data_request - 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_createauthority_data_request_brrd_01, operation_id: OBPv4.0.0-dynamicEntity_createauthority_data_request_brrd_01 Tags: _Authority Data Request(brrd 01), Dynamic-Entity, Dynamic,

Delete Authority Data Request by id

Delete Authority Data Request 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":"authority_data_request"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanDeleteDynamicEntity_authority_data_request - 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_deleteauthority_data_request_brrd_01, operation_id: OBPv4.0.0-dynamicEntity_deleteauthority_data_request_brrd_01 Tags: _Authority Data Request(brrd 01), Dynamic-Entity, Dynamic,

Get Authority Data Request List

Get Authority Data Request List.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Can do filter on the fields
e.g: /authority_data_request?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", "authority_data_request_list":[{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }] }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getauthority_data_requestList_brrd_01, operation_id: OBPv4.0.0-dynamicEntity_getauthority_data_requestList_brrd_01 Tags: _Authority Data Request(brrd 01), Dynamic-Entity, Dynamic,

Get Authority Data Request by id

Get Authority Data Request by id.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanGetDynamicEntity_authority_data_request - 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_getSingleauthority_data_request_brrd_01, operation_id: OBPv4.0.0-dynamicEntity_getSingleauthority_data_request_brrd_01 Tags: _Authority Data Request(brrd 01), Dynamic-Entity, Dynamic,

Update Authority Data Request

Update Authority Data Request.

Legal request to give customer data to the authorities

Property List:

  • customer_number: Customer reference number
  • mandate_name: The legal act the request is based on
  • mandate_name_year: The year when the legal act the request is based on was passed

MethodRouting settings example:

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "authority_data_request":{ "authority_data_requestId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "customer_number":"1234567", "mandate_name":"National Anti-Fraud Act", "mandate_name_year":"1978" } }
Required Roles:
  • CanUpdateDynamicEntity_authority_data_request - 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_updateauthority_data_request_brrd_01, operation_id: OBPv4.0.0-dynamicEntity_updateauthority_data_request_brrd_01 Tags: _Authority Data Request(brrd 01), Dynamic-Entity, Dynamic,

Create new Foo Bar

Create new Foo Bar.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanCreateDynamicEntity_SystemFooBar - 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_createFooBar_, operation_id: OBPv4.0.0-dynamicEntity_createFooBar_ Tags: _Foo Bar, Dynamic-Entity, Dynamic,

Delete Foo Bar by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanDeleteDynamicEntity_SystemFooBar - 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_deleteFooBar_, operation_id: OBPv4.0.0-dynamicEntity_deleteFooBar_ Tags: _Foo Bar, Dynamic-Entity, Dynamic,

Get Foo Bar List

Get Foo Bar List.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Can do filter on the fields
e.g: /FooBar?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:

								
									
{ "foo_bar_list":[{ "foo_bar":{ "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }] }
Required Roles:
  • CanGetDynamicEntity_SystemFooBar - 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_getFooBarList_, operation_id: OBPv4.0.0-dynamicEntity_getFooBarList_ Tags: _Foo Bar, Dynamic-Entity, Dynamic,

Get Foo Bar by id

Get Foo Bar by id.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanGetDynamicEntity_SystemFooBar - 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_getSingleFooBar_, operation_id: OBPv4.0.0-dynamicEntity_getSingleFooBar_ Tags: _Foo Bar, Dynamic-Entity, Dynamic,

Update Foo Bar

Update Foo Bar.

Description of this entity, can be markdown text.

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "foo_bar":{ "fooBarId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Required Roles:
  • CanUpdateDynamicEntity_SystemFooBar - 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_updateFooBar_, operation_id: OBPv4.0.0-dynamicEntity_updateFooBar_ Tags: _Foo Bar, Dynamic-Entity, Dynamic,

Create new Obp Activity

Create new Obp Activity.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanCreateDynamicEntity_ObpActivity - 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_createObpActivity_trn.34.my.strings, operation_id: OBPv4.0.0-dynamicEntity_createObpActivity_trn.34.my.strings Tags: _Obp Activity(trn.34.my.strings), Dynamic-Entity, Dynamic,

Delete Obp Activity by id

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

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanDeleteDynamicEntity_ObpActivity - 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_deleteObpActivity_trn.34.my.strings, operation_id: OBPv4.0.0-dynamicEntity_deleteObpActivity_trn.34.my.strings Tags: _Obp Activity(trn.34.my.strings), Dynamic-Entity, Dynamic,

Get Obp Activity List

Get Obp Activity List.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /ObpActivity?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", "obp_activity_list":[{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }] }
Required Roles:
  • CanGetDynamicEntity_ObpActivity - 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_getObpActivityList_trn.34.my.strings, operation_id: OBPv4.0.0-dynamicEntity_getObpActivityList_trn.34.my.strings Tags: _Obp Activity(trn.34.my.strings), Dynamic-Entity, Dynamic,

Get Obp Activity by id

Get Obp Activity by id.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanGetDynamicEntity_ObpActivity - 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_getSingleObpActivity_trn.34.my.strings, operation_id: OBPv4.0.0-dynamicEntity_getSingleObpActivity_trn.34.my.strings Tags: _Obp Activity(trn.34.my.strings), Dynamic-Entity, Dynamic,

Update Obp Activity

Update Obp Activity.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • username: description of name field, can be markdown text.
  • created_date: 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":"ObpActivity"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response:

								
									
{ "bank-id":"gh.29.uk", "obp_activity":{ "obpActivityId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "username":"James Brown", "created_date":"698761728" } }
Required Roles:
  • CanUpdateDynamicEntity_ObpActivity - 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_updateObpActivity_trn.34.my.strings, operation_id: OBPv4.0.0-dynamicEntity_updateObpActivity_trn.34.my.strings Tags: _Obp Activity(trn.34.my.strings), Dynamic-Entity, Dynamic,