API Explorer

MXOFv1.0.0 (57 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Accounts Parties by AccountId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

  • ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "Party":[{ "BeneficialOwnership":true, "Address":[{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } },{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } }], "AccountRole":{ }, "Mobile":{ }, "EmailAddress":{ }, "LegalStructure":{ }, "Name":{ }, "PartyNumber":{ }, "Relationships":{ "Account":{ "Related":"http://example.com/aeiou", "Id":"Id" } }, "FullLegalName":{ }, "PartyId":{ }, "Phone":{ }, "PartyType":{ } },{ "BeneficialOwnership":true, "Address":[{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } },{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } }], "AccountRole":{ }, "Mobile":{ }, "EmailAddress":{ }, "LegalStructure":{ }, "Name":{ }, "PartyNumber":{ }, "Relationships":{ "Account":{ "Related":"http://example.com/aeiou", "Id":"Id" } }, "FullLegalName":{ }, "PartyId":{ }, "Phone":{ }, "PartyType":{ } }] } }
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: BAHRAIN-OBFv1.0.0, function_name: by accountsAccountIdPartiesGet, operation_id: BAHRAIN-OBFv1.0.0-accountsAccountIdPartiesGet Tags: Parties, Mocked-Data,

Get Accounts Party by AccountId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

  • ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "Party":{ "BeneficialOwnership":true, "Address":[{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } },{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } }], "AccountRole":{ }, "Mobile":{ }, "EmailAddress":{ }, "LegalStructure":{ }, "Name":{ }, "PartyNumber":{ }, "Relationships":{ "Account":{ "Related":"http://example.com/aeiou", "Id":"Id" } }, "FullLegalName":{ }, "PartyId":{ }, "Phone":{ }, "PartyType":{ } } } }
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: BAHRAIN-OBFv1.0.0, function_name: by accountsAccountIdPartyGet, operation_id: BAHRAIN-OBFv1.0.0-accountsAccountIdPartyGet Tags: Parties, Mocked-Data,

Get Party

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "Party":{ "BeneficialOwnership":true, "Address":[{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } },{ "CountrySubDivision":{ }, "StreetName":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "AddressType":{ }, "PostCode":{ } }], "AccountRole":{ }, "Mobile":{ }, "EmailAddress":{ }, "LegalStructure":{ }, "Name":{ }, "PartyNumber":{ }, "Relationships":{ "Account":{ "Related":"http://example.com/aeiou", "Id":"Id" } }, "FullLegalName":{ }, "PartyId":{ }, "Phone":{ }, "PartyType":{ } } } }
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: BAHRAIN-OBFv1.0.0, function_name: by partyGet, operation_id: BAHRAIN-OBFv1.0.0-partyGet Tags: Parties, Mocked-Data,