Search for parties in the core banking system
GET/v1/parties/search
Search for existing parties in the core banking system (CBS) by query parameters.
Search intent is determined by which parameters are provided — no explicit entity type is required:
- Individual search: provide
firstNameandlastName(plus optionalmiddleName). - Company search: provide
name.
Exactly one set of parameters must be provided per request:
- Providing both (
firstName/lastName) ANDnamein the same request returns HTTP 400 PAR000012. - Providing neither returns HTTP 400 PAR000011.
Returns a minimal array of matching party candidates. An empty results array indicates no match found and is a valid response.
Authentication: Requires a valid identity provider token with CLIENT role plus clientid and brandid headers, consistent with POST /v1/parties/provision and POST /v1/parties/kyx.
Note — dateOfBirth is not accepted as a search parameter. The CBS search matches on last name and first letter of first name only. Date of birth is returned in the response for individual candidates so that callers can confirm or dismiss a match.
Request
Responses
- 200
- 400
- 401
- 403
- 422
- 500
- 503
Search completed successfully. Returns a results array of matching party candidates.
An empty array indicates no matches were found — this is a valid and expected no-match response.
Bad Request:
- Required search parameters are missing — neither (firstName + lastName) nor name was provided (PAR000011)
- Conflicting search parameters — both (firstName/lastName) and name were provided (PAR000012)
- Schema validation error (GEN000000)
Missing or invalid authentication token (GEN001002) or Role unauthorized (GEN001006) or Tenant context could not be resolved (AUT001001)
External application access denied (AUT003001)
Capability not configured for this tenant (CRT022003)
Internal server error (GEN100000) or Service error (GEN100001) or party search downstream error (PAR100008)
All connector targets are currently unhealthy (CRT103001)