Search customers

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 and Processing Org
shortName	string Search by Customer short name
customerId	string Search by customerId
customerUID	string Search by customer unique id.
status	string Search by status
taxId	string Search by taxId
page required	string Which number of page of results to be returned Example: page=1
limit required	string <= 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

402

The parameters were valid but the request failed.

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

409

The request conflicts with another request (perhaps due to using the same idempotent key).

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500

Something went wrong on back end.

503

Service unavailable

default

Successful

get/v2/customers

Request samples

curl
JavaScript
Node.js

Response samples

200
500
default

application/json

{"status": "Success",
"code": "CUST001",
"message": "Failed to get the customer: <Reason>",
"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": "ABC1234",
"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",
"countryCode": "USA"
},
"mailAddressSameAsLegal": true,
"mailingAddress": {"addressLine1": "111 My Street",
"addressLine2": "Suite 210",
"city": "Charlotte",
"state": "North Carolina",
"postalCode": "28269",
"countryCode": "USA"
},
"relationshipType": "Customer or Bank or ThirdParty or Self",
"partnerOrgShortName": "TESTBANK",
"processingOrgShortName": "POBANK",
"costCenter": "123123121",
"relationshipManager": "testuser",
"originatingOfficer": "testuser",
"parentEntityShortName": "TESTBANK",
"additionalProfileDetails": {"creditClient": true,
"sso": true,
"billingCustomer": true,
"restrictedAccess": true,
"achPositivePay": true,
"achWhitelist": true,
"paymentFileAuthentication": true,
"detailsOfCharge": "OUR",
"fxPricingTier": "Finzly Test",
"creditValueAdjustment": "0.00010"
},
"secCodes": ["WEB"
],
"note": "Notes for the customer"
}
]
}