Skip to main content
This endpoint retrieves a list of existing profiles that can be used to create a Customer Related Party (CRP). It allows you to search for profiles by name and filter by customer type. This API is typically used as the first step in the process of creating a CRP with an existing profile.

​
Use Cases

  • Reuse Existing Profile: Search for an existing customer profile to reuse when creating a new CRP
  • Profile Selection: Find profiles that match specific criteria before linking them to a main customer
  • Data Consistency: Ensure consistency by using existing, validated profiles for new CRPs

​
Path Parameters

  • type — The customer type to search for.
    • Required: Yes
    • Enum: INDIVIDUAL or CORPORATE
    • Example: INDIVIDUAL
  • mainCustomerId — The ID of the main customer to which the CRP will be associated.
    • Required: Yes
    • Type: Number
    • Example: 1234

​
Query Parameters

  • searchString — The name or partial name of the profile to search for.
    • Required: No
    • Type: String
    • Example: Aiden

​
Headers

  • x-domain — Domain identifier for the request.
    • Required: Yes
    • Type: Number
    • Example: 1

​
Response Fields

The response contains a paginated list of customer candidates matching the search criteria.

​
Key Fields to Extract

When creating a CRP with an existing profile, you’ll need to extract these fields from the response:
  • customerCandidate.profileId — The unique identifier of the profile (required for CRP creation)
  • customerCandidate.profileReferenceId — The reference ID of the profile
  • customerCandidate.particular — Complete particular information (synced with original profile)
  • customerCandidate.other — Other information (carried over but not synced)

​
Important Notes

Profile LinkageWhen using the search results to create a CRP:
  • The profileId must be included in the CRP creation request
  • The profileReferenceId can be modified but will affect the original profile
  • The particular fields are synced between the CRP and original profile
  • The other fields are copied but maintained separately for the CRP
Search Behavior
  • If searchString is not provided, all profiles matching the type will be returned
  • The search is typically case-insensitive and supports partial matches
  • Results are paginated and sorted by creation date (most recent first)

​
Next Steps

After retrieving the profile:
  1. Extract the profileId and profileReferenceId from the response
  2. Use these values in the Create CRP request
  3. Include the particular and other objects from the profile in the CRP creation payload
For a complete workflow example, see Create CRP with Existing Profile.

​
Example Usage

GET /api/customer/profile/INDIVIDUAL/1234?searchString=Aiden
Headers:
  x-domain: 1
This will return all individual profiles containing “Aiden” in the name that can be linked to customer ID 1234.