Browse parties and optionally filtered by criteria. Results are paginated.
Security
basicAuth
- Test (Try)https://try.access.worldpay-bsh.securedataplatform.co.uk/parties
- Livehttps://access.worldpay-bsh.securedataplatform.co.uk/parties
curl -i -X GET \
-u '<username>:<password>' \
'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties?page=5&size=10&entity=Entity123%2CEntity456&active=true&type=soleTrader%2Ccompany' \
-H 'WP-Api-Version: 2025-01-01'Response
Browse parties
{ "parties": [ { "identityVerificationState": "notVerified", "identityVerificationMethod": "identityVerificationService", "merchant": { "entity": "default" }, "partyReference": "ts6SfP8eNv", "partyType": "beneficiary", "type": "person", "partyId": "parJnf1XbmhV6j2cizaFQ54L0", "email": "zH5O.V20XrO71@yWPtULl.cl4", "phones": [ { "prefix": "44", "number": "km86YWLfjyL" } ], "identityDocuments": [ { "type": "passport", "number": "zuggHJuTi", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "1901-03-20", "validTo": "1931-07-31" }, { "type": "nationalId", "number": "f1wlKPlz-8mXmh", "issuingInstitution": "Zaibatsu Holding HR Dept.", "issuingCountry": "GB", "validFrom": "1915-09-06", "validTo": "1988-04-03" } ], "balanceAccounts": [], "dateTimeCreated": "2025-09-02T15:51:53.868Z", "dateTimeUpdated": "2025-09-03T15:51:54.257Z", "version": 2, "payoutInstruments": [], "active": true, "dateTimeDeactivated": "2025-09-03T15:51:54.211Z", "dateTimeActivated": "2025-09-02T15:51:54.257Z", "personalDetails": { "title": "Mr", "firstName": "sa7h", "middleName": "G3d3c", "lastName": "eFGwfD84", "alias": "John bailey", "socialSecurityNumber": "333-55-1666", "dateOfBirth": "2059-01-03", "address": { "address1": "T6cF ubKLq1oMt xWHke", "address2": "lDdv v5", "city": "Manchester", "countryCode": "GB", "postalCode": "XF 9wj", "type": "home" }, "residentialStatus": "resident", "currentAddressLessThanThreeYears": false } }, { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "merchant": { "entity": "default" }, "partyReference": "Z4AS5O3gVA", "partyType": "beneficiary", "type": "person", "partyId": "parBCjKONvmeYaSK--v_NJK40", "email": "zH5O.V20XrO71@yWPtULl.cl4", "phones": [ { "prefix": "44", "number": "km86YWLfjyL" } ], "identityDocuments": [ { "type": "passport", "number": "zuggHJuTi", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "1901-03-20", "validTo": "1931-07-31" }, { "type": "nationalId", "number": "f1wlKPlz-8mXmh", "issuingInstitution": "Zaibatsu Holding HR Dept.", "issuingCountry": "GB", "validFrom": "1915-09-06", "validTo": "1988-04-03" } ], "balanceAccounts": [ { "currency": "GBP", "payoutInstrumentReference": "UtwzOwGHMM", "scheduledPayoutDay": "thursday", "frequency": "weekly", "balanceAccountId": "parVUdr_mDPwl1EY3Pb5y-Cp0", "dateTimeCreated": "2026-03-02T15:51:54.638Z", "version": 0, "accountNumber": "12343242", "nextPayoutDate": "2026-03-19" }, { "currency": "EUR", "payoutInstrumentReference": "hCpcT6vTPB", "scheduledPayoutDay": "thursday", "frequency": "monthly", "recurrence": "third", "balanceAccountId": "paruowtxO9OPFIGjx9gYl5iE0", "dateTimeCreated": "2026-03-02T15:51:58.314Z", "version": 0, "accountNumber": "12343242", "nextPayoutDate": "2026-04-19" }, { "currency": "INR", "payoutInstrumentReference": "hCpcT6vTPB", "frequency": "daily", "balanceAccountId": "paruowtCO9OPFIGjx9gYl5iE0", "dateTimeCreated": "2026-03-02T15:51:54.638Z", "version": 0, "accountNumber": "12343242", "nextPayoutDate": "2026-03-03" } ], "dateTimeCreated": "2026-03-02T15:51:54.638Z", "version": 0, "payoutInstruments": [ { "payoutInstrumentReference": "hCpcT6vTPB", "payoutInstrumentId": "par35uirx_fJZ9bjGu24UBB50", "payoutInstrumentType": "bankAccount", "currency": "EUR", "dateTimeCreated": "2025-09-02T15:51:56.889Z", "version": 0, "accountHolderName": "UVfn D. kQdAzJRB", "swiftBic": "1i08of9G", "bankCode": "b4ZM5E", "accountNumber": "xL60ChVg", "accountType": "checking", "iban": "WU0jAupifqjpgZ8pPIYb", "bankName": "Metro Bank", "address": { "address1": "bY o7a-IOeFVa rsxklGj8g 5FCB7", "address2": "ohXty YYBO", "city": "London", "countryCode": "GB", "postalCode": "Bs4j IqO", "type": "business" }, "branchCode": "Barclays Branch" }, { "payoutInstrumentReference": "UtwzOwGHMM", "payoutInstrumentId": "parAh7-5xjnkGUp4TmvJ0Vj00", "payoutInstrumentType": "bankAccount", "currency": "GBP", "dateTimeCreated": "2025-09-02T15:51:54.638Z", "version": 0, "accountHolderName": "UVfn D. kQdAzJRB", "swiftBic": "1i08of9G", "bankCode": "b4ZM5E", "accountNumber": "xL60ChVg", "accountType": "checking", "iban": "WU0jAupifqjpgZ8pPIYb", "bankName": "HSBC UK BANK PLC", "address": { "address1": "bY o7a-IOeFVa rsxklGj8g 5FCB7", "address2": "ohXty YYBO", "city": "London", "countryCode": "GB", "postalCode": "Bs4j IqO", "type": "business" }, "branchCode": "Taunton Branch" } ], "active": true, "dateTimeActivated": "2026-03-02T15:51:54.638Z", "personalDetails": { "title": "Mr", "firstName": "sa7h", "middleName": "G3d3c", "lastName": "eFGwfD84", "alias": "John bailey", "socialSecurityNumber": "333-55-1666", "dateOfBirth": "2059-01-03", "address": { "address1": "T6cF ubKLq1oMt xWHke", "address2": "lDdv v5", "city": "Manchester", "countryCode": "GB", "postalCode": "XF 9wj", "type": "home" }, "residentialStatus": "resident", "currentAddressLessThanThreeYears": false } }, { "identityVerificationState": "notVerified", "identityVerificationMethod": "identityVerificationService", "merchant": { "entity": "default" }, "partyReference": "xHyFiJS9zo", "partyType": "beneficiary", "type": "soleTrader", "partyId": "parqZvn1ritjWZbD4yRxEpCd0", "email": "A4P.X6MrD@4zKMG8L.AeB", "phones": [ { "prefix": "81", "number": "mSaIgVfwZw" } ], "identityDocuments": [ { "type": "taxRegistrationCode", "number": "jdZ", "issuingInstitution": "HMRC", "issuingCountry": "GB", "validFrom": "1945-06-07", "validTo": "2078-12-08" }, { "type": "passport", "number": "7P6", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "2060-03-27", "validTo": "2067-03-22" } ], "balanceAccounts": [ { "currency": "GBP", "balanceAccountId": "pare151tM6polLGHRMSQsWeO0", "dateTimeCreated": "2025-09-02T15:51:55.144Z", "version": 0, "accountNumber": "0000550000085002" }, { "currency": "USD", "payoutInstrumentReference": "kNiuKzkNlO", "scheduledPayoutDay": "thursday", "frequency": "weekly", "balanceAccountId": "parr9a1J5alvURV2KrWFi8880", "dateTimeCreated": "2025-09-02T15:51:58.578Z", "version": 0, "accountNumber": "0000550000085002", "nextPayoutDate": "2026-03-19" } ], "dateTimeCreated": "2025-09-02T15:51:55.144Z", "version": 0, "payoutInstruments": [ { "payoutInstrumentReference": "kNiuKzkNlO", "payoutInstrumentId": "parlnjkdCvxRKCEdXO6QWbYG0", "payoutInstrumentType": "bankAccount", "currency": "USD", "dateTimeCreated": "2025-09-02T15:51:57.484Z", "version": 0, "accountHolderName": "UVfn D. kQdAzJRB", "swiftBic": "1i08of9G", "bankCode": "b4ZM5E", "accountNumber": "xL60ChVg", "accountType": "checking", "iban": "WU0jAupifqjpgZ8pPIYb", "bankName": "Metro Bank", "address": { "address1": "bY o7a-IOeFVa rsxklGj8g 5FCB7", "address2": "ohXty YYBO", "city": "London", "countryCode": "GB", "postalCode": "Bs4j IqO", "type": "business" }, "branchCode": "Barclays Branch" }, { "payoutInstrumentReference": "O6zUzth3o6", "payoutInstrumentId": "parrTlcspjYj2bqeYIez_tMz0", "payoutInstrumentType": "bankAccount", "currency": "GBP", "dateTimeCreated": "2025-09-02T15:51:55.144Z", "version": 0, "accountHolderName": "51B6k qmw", "swiftBic": "n45SZCRQ", "bankCode": "6c1tT8", "accountNumber": "utJkHSus", "accountType": "savings", "iban": "mUWBqpkz8lHlBLKAF5WdUR5", "bankName": "Lloyds Bank", "address": { "address1": "roQ UHnZ87 V5x52Q", "address2": "xpWWt 6I", "city": "London", "countryCode": "GB", "postalCode": "AD 9Tz", "type": "other" }, "branchCode": "Bradford Branch" } ], "active": true, "dateTimeActivated": "2025-09-02T15:51:55.144Z", "personalDetails": { "title": "Ms", "firstName": "hm70O", "middleName": "OSoc", "lastName": "52M", "tradingName": "Linda Lee", "alias": "John bailey", "socialSecurityNumber": "333-55-1666", "taxIdentifier": "TX-12354567", "dateOfBirth": "2040-01-09", "address": { "address1": "yWh bzP9Fa luw8GI", "address2": "sqdo Rtt", "city": "Chester", "countryCode": "GB", "postalCode": "Ib4 VJk", "type": "home" }, "residentialStatus": "resident", "customerReference": "customerrefSoleTrader", "nationality": "lw", "currentAddressLessThanThreeYears": true, "previousHomeAddress": { "address1": "xQ6 ZfG8qm YD0fTH", "address2": "SWMR G2f", "city": "Chester", "countryCode": "GB", "postalCode": "gV5 35W", "type": "other" }, "website": "https://www.example.com/", "merchantCategoryCode": "5411", "merchantCategoryCodeDescription": "Grocery Stores, Supermarkets" } }, { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "merchant": { "entity": "default" }, "partyReference": "G5ohEB3lUc", "partyType": "beneficiary", "type": "company", "partyId": "par7anQCsbhS0yKZNIFpUtkI0", "email": "info@example.com", "phones": [ { "prefix": "81", "number": "8475932" } ], "identityDocuments": [], "balanceAccounts": [ { "currency": "EUR", "payoutInstrumentReference": "mHWwfCJRCS", "scheduledPayoutDay": "thursday", "frequency": "weekly", "balanceAccountId": "parKwY5ezX2R4QaUGQ47cGYi0", "dateTimeCreated": "2025-09-02T15:51:55.678Z", "dateTimeUpdated": "2025-09-03T15:51:55.678Z", "version": 1, "accountNumber": "12343242", "nextPayoutDate": "2026-03-19" }, { "currency": "USD", "payoutInstrumentReference": "u8MamGFmEo", "scheduledPayoutDay": "thursday", "frequency": "weekly", "balanceAccountId": "parUoWq2uerKMrdAPFeBLqy80", "dateTimeCreated": "2025-09-02T15:51:58.849Z", "dateTimeUpdated": "2025-09-03T15:51:55.678Z", "version": 1, "accountNumber": "12343242", "nextPayoutDate": "2026-03-19" }, { "currency": "GBP", "balanceAccountId": "parfnsCbzM7Og3xIdfa48tAZ0", "dateTimeCreated": "2025-09-02T15:51:55.678Z", "version": 0, "accountNumber": "12343242" } ], "dateTimeCreated": "2025-09-02T15:51:56.295Z", "dateTimeUpdated": "2025-09-03T15:51:55.678Z", "version": 2, "payoutInstruments": [ { "payoutInstrumentReference": "u8MamGFmEo", "payoutInstrumentId": "parSALwf8D8drIikDp0aQTrG0", "payoutInstrumentType": "bankAccount", "currency": "USD", "dateTimeCreated": "2025-09-02T15:51:57.887Z", "dateTimeUpdated": "2025-09-03T15:51:55.678Z", "version": 1, "accountHolderName": "f3T5owE-5hZQQVR rYYIJel eOt.", "swiftBic": "pogwBatv", "bankCode": "b4ZM5E", "accountNumber": "iZOB5YkF", "accountType": "savings", "iban": "5YHuGEWGF61PlsAUAKkryp", "bankName": "Freeside Financial Corporation", "address": { "address1": "q fbyli 0kyimLrIfq", "address2": "7NOmwxh7", "city": "York", "state": "NA", "countryCode": "GB", "postalCode": "HJMW DKJn", "type": "business" }, "branchCode": "Muswell Hill Branch" }, { "payoutInstrumentReference": "mHWwfCJRCS", "payoutInstrumentId": "parpxxzfRTafscKcMwvERKGf0", "payoutInstrumentType": "bankAccount", "currency": "EUR", "dateTimeCreated": "2025-09-02T15:51:55.677Z", "dateTimeUpdated": "2025-09-03T15:51:55.678Z", "version": 1, "accountHolderName": "f3T5owE-5hZQQVR rYYIJel eOt.", "swiftBic": "QnDYJdbt", "bankCode": "b4ZM5E", "accountNumber": "utJkHSus", "accountType": "savings", "iban": "5YHuGEWGF61PlsAUAKkryp", "bankName": "Freeside Financial Corporation", "address": { "address1": "q fbyli 0kyimLrIfq", "address2": "7NOmwxh7", "city": "London", "countryCode": "GB", "postalCode": "Bs4j IqO", "type": "business" }, "branchCode": "Barclays Branch" } ], "active": true, "dateTimeActivated": "2025-09-02T15:51:56.295Z", "companyDetails": { "merchantCategoryCode": "5734", "merchantCategoryCodeDescription": "Computer Software Stores", "website": "https://www.example.com", "legalName": "Tessier-Ashpool Systems Ltd.", "tradingName": "Example.co.uk", "registrationNumber": "7564389201", "taxIdentifier": "GB-987654321", "companyType": "publicLimitedCompany", "dateOfIncorporation": "1977-07-04", "legalAddress": { "address1": "7 Straylight Complex", "address2": "Corporate District, Level 99", "city": "London", "countryCode": "GB", "postalCode": "EC1A 1BB", "type": "business" }, "tradingAddress": { "address1": "789 Freeside Blvd", "address2": "Villa Straylight", "city": "Manchester", "countryCode": "GB", "postalCode": "M1 1AA", "type": "poBox" }, "customerReference": "CustRefZA98765" }, "beneficialOwners": [ { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "beneficialOwnerReference": "GJbPJVtqFz", "beneficialOwnerId": "par5BsbOKDecm8uWVgzYUor-0", "personalDetails": { "title": "Ms", "firstName": "John", "middleName": "LVrVLk", "lastName": "Bailer", "alias": "John bailey", "socialSecurityNumber": "333-55-1666", "dateOfBirth": "1946-09-13", "address": { "address1": "YZ7 1V7iJh xnZhNA", "address2": "8DD6 7fg", "city": "Burbank", "countryCode": "GB", "postalCode": "rmL v0W" }, "residentialStatus": "resident", "nationality": "lw", "currentAddressLessThanThreeYears": true, "previousHomeAddress": { "address1": "xgi osd16 bsMJ 1nnj", "address2": "SWMR G2f", "city": "Night City", "countryCode": "GB", "postalCode": "s2W CV6" } }, "relationshipToBusiness": { "ownershipPercentage": 25, "director": false, "isPrincipalOwner": true, "position": "officeManager" }, "email": "UucOR.ppaJ1rdP@4BLu9KX.54i", "phones": [ { "prefix": "44", "number": "km86YWLfjyL" } ], "identityDocuments": [ { "type": "passport", "number": "sJCY65PyZ", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "1922-10-07", "validTo": "2043-06-08" } ], "dateTimeCreated": "2025-09-02T15:51:55.678Z", "dateTimeUpdated": "2025-09-03T15:51:55.678Z", "version": 1 }, { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "beneficialOwnerReference": "YezTTwoVHR", "beneficialOwnerId": "parIrzObRP9_nc7Y5R29fgoC0", "personalDetails": { "title": "Dr", "firstName": "Johny", "middleName": "tusFSTLKvR", "lastName": "pkw1XH1", "alias": "John bailey", "socialSecurityNumber": "333-55-1666", "dateOfBirth": "2062-04-19", "address": { "address1": "AI6 TyzGI5B YprQ7Y", "address2": "05uX xGG", "city": "London", "countryCode": "GB", "postalCode": "Dv4T erT", "type": "home" }, "residentialStatus": "nonResident", "nationality": "lw", "currentAddressLessThanThreeYears": true, "previousHomeAddress": { "address1": "CIo U0wJ3a 1k3rwN", "address2": "8DD6 7fg", "city": "London", "countryCode": "GB", "postalCode": "bZX TqF", "type": "home" } }, "relationshipToBusiness": { "ownershipPercentage": 10, "director": false, "position": "partner" }, "email": "PuDnv.iX8XrhV@X8RQ3S5.4IC", "phones": [ { "prefix": "44", "number": "Z0avBNjMlS" } ], "identityDocuments": [ { "type": "passport", "number": "v2OhZxguD", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "1989-06-06", "validTo": "2028-03-19" } ], "dateTimeCreated": "2025-09-02T15:51:55.678Z", "dateTimeUpdated": "2025-09-03T15:51:55.678Z", "version": 1 }, { "identityVerificationState": "started", "identityVerificationMethod": "identityVerificationService", "beneficialOwnerReference": "zHCxMG8x4T", "beneficialOwnerId": "parT4dazXixMu5npZGQL0iwH0", "personalDetails": { "title": "Dr", "firstName": "Jenly", "middleName": "tusFSTLKvR", "lastName": "Morris", "alias": "John bailey", "socialSecurityNumber": "333-55-1666", "dateOfBirth": "1918-01-01", "address": { "address1": "NLv QCTjBRt P4cpVy", "address2": "05uX xGG", "city": "London", "countryCode": "GB", "postalCode": "Dv4T erT", "type": "home" }, "residentialStatus": "nonResident", "nationality": "lw", "currentAddressLessThanThreeYears": true, "previousHomeAddress": { "address1": "ceR 7DcVj9 qP6wd4", "address2": "8DD6 7fg", "city": "London", "countryCode": "GB", "postalCode": "bZX TqF", "type": "home" } }, "relationshipToBusiness": { "ownershipPercentage": 10, "director": false, "position": "partner" }, "email": "9UFJ.oVZsgU@laUTWaJ.rs0", "phones": [ { "prefix": "44", "number": "Z0avBNjMlS" } ], "identityDocuments": [ { "type": "passport", "number": "v2OhZxguD", "issuingInstitution": "UK Passport Office", "issuingCountry": "GB", "validFrom": "1989-06-06", "validTo": "2028-03-19" } ], "dateTimeCreated": "2025-09-02T15:51:56.294Z", "dateTimeUpdated": "2025-09-03T15:51:56.294Z", "version": 1 } ] } ], "pagination": { "page": 0, "size": 10, "pageCount": 1, "totalNumberOfRecords": 4 } }