Search customers

Search and retrieve customers associated with a customer based on their search parameters.

SecurityoAuth2

Request

query Parameters

legalName	string Full text search of full legal name
customerType	string Search by type of customer such as Corporate, Consumer, Financial_Institution, Downstream_Partner.
shortName	string Search by Customer short name
customerId	string Search by customerId
customerUID	integer Search by customer unique id.
status	string Search by status
taxId	string Search by taxId
page required	integer Which number of page of results to be returned Example: page=1
limit required	integer <= 1000 Total number of records to be returned for a given page Example: limit=100

Responses

200

400

bad input parameter environment

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

405

bad input parameter environment

500

Something went wrong on back end.

503

Service unavailable

default

Successful

get/v2/customers

Request samples

curl
JavaScript
Node.js

Response samples

200
400
500
default

application/json

{"status": "Success",
"code": "string",
"message": "string",
"pagination": {"totalRecords": 100,
"returnedRecords": 10,
"pageReturned": 2,
"pageSize": 10
},
"data": [{"legalName": "DEMO Bank",
"shortName": "DMOB",
"customerUID": 111222,
"customerType": "Consumer or Corporate or Downstream Partner or Processing Org or Financial Institution",
"taxId": "123456789",
"customerId": "12347890",
"status": "Active",
"lei": "5493001KJTIIGC8Y1R12",
"swiftCode": "BOFAUS3N",
"language": "English",
"emailAddress": "abc@bank.com",
"faxNumber": "1231249877",
"webSite": "http://www.bank.com",
"logoUrl": "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png",
"twitterUrl": "https://twitter.com/bank",
"legalAddress": {"addressLine1": "111 My Street",
"addressLine2": "Suite 210",
"city": "Charlotte",
"state": "North Carolina",
"postalCode": "28269",
"country": "UNITED STATES OF AMERICA",
"countryCode": "US"
},
"mailAddressSameAsLegal": true,
"mailingAddress": {"addressLine1": "111 My Street",
"addressLine2": "Suite 210",
"city": "Charlotte",
"state": "North Carolina",
"postalCode": "28269",
"country": "UNITED STATES OF AMERICA",
"countryCode": "US"
},
"relationshipType": "Customer or Bank or ThirdParty or Self",
"partnerOrgShortName": "TESTBANK",
"processingOrgShortName": "POBANK",
"costCenter": "123123121",
"relationshipManager": "testuser",
"originatingOfficer": "testuser",
"parentEntityShortName": "TESTBANK",
"additionalProfileDetails": {"sso": true,
"billingCustomer": true,
"restrictedAccess": true,
"achPositivePay": false,
"achWhitelist": true,
"paymentFileAuthentication": true,
"detailsOfCharge": "OUR",
"fxPricingTier": "Finzly Test",
"creditValueAdjustment": 0.0001
},
"note": "Notes for the customer",
"legalEntityOriginatingOfficer": "sashi100",
"legalEntityRelationshipManager": "sashi100"
}
]
}