GET v1/Customers/Search?FullName={FullName}&CustomerType={CustomerType}&Email={Email}&Address1={Address1}&Zipcode1={Zipcode1}&City={City}&StateCode={StateCode}&CountryId={CountryId}&PhoneNumber={PhoneNumber}&LegalStatusId={LegalStatusId}&BirthDate={BirthDate}&CitizenCountryId={CitizenCountryId}&BirthCountryId={BirthCountryId}&Fein={Fein}&YearStarted={YearStarted}&EstablishCountryId={EstablishCountryId}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}

Customer Clearance Search

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FullName

string

String length: inclusive between 0 and 500

CustomerType

integer

Required

Email

string

None.

Address1

string

None.

Zipcode1

string

None.

City

string

None.

StateCode

string

None.

CountryId

integer

None.

PhoneNumber

string

None.

LegalStatusId

LegalStatusEnum

None.

BirthDate

date

None.

CitizenCountryId

integer

None.

BirthCountryId

integer

None.

Fein

string

None.

YearStarted

integer

None.

EstablishCountryId

integer

None.

Limit

Maximum number of records to return

integer

Range: inclusive between 1 and 2147483647

Offset

Number of records to skip during search, useful for pagination

integer

Range: inclusive between 0 and 2147483647

Total

Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets.

boolean

None.

SortDirection

Direction of sort: Ascending or Descending

SortDirection

None.

Sort

Comma separated list of field names to sort by

string

None.

Expand

Comma separated list of expansions to include in results

string

None.

Body Parameters

None.

Response Information

Resource Description

CustomerSearchListResponse
NameDescriptionTypeAdditional information
Limit

Echoed limit of request

integer

None.

Offset

Echoed offset of request

integer

None.

Total

Total records matching search, if requested

integer

None.

Data

List of records matching the search

Collection of CustomerClearanceOutboundDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "Limit": 1,
  "Offset": 1,
  "Total": 1,
  "Data": [
    {
      "FullName": "sample string 1",
      "CustomerType": "Unknown",
      "Id": 2,
      "PrimaryEmailAddress": "sample string 3",
      "SecondaryEmailAddress": "sample string 4",
      "RiskAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "MailingAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "HomeAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "WorkAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "WorkPhoneNumber": "sample string 5",
      "HomePhoneNumber": "sample string 6",
      "Mobile1PhoneNumber": "sample string 7",
      "Mobile2PhoneNumber": "sample string 8",
      "FaxPhoneNumber": "sample string 9",
      "BirthDate": "2023-01-30T12:19:57.3153983-10:00",
      "CitizenCountryId": 1,
      "BirthCountryId": 1,
      "Fein": "sample string 10",
      "YearStarted": 1,
      "EstablishCountryId": 1
    },
    {
      "FullName": "sample string 1",
      "CustomerType": "Unknown",
      "Id": 2,
      "PrimaryEmailAddress": "sample string 3",
      "SecondaryEmailAddress": "sample string 4",
      "RiskAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "MailingAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "HomeAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "WorkAddress": {
        "Type": "Unknown",
        "Address1": "sample string 1",
        "Address2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "County": "sample string 5",
        "Country": "sample string 6",
        "Zipcode1": "sample string 7",
        "Zipcode2": "sample string 8",
        "Id": 9
      },
      "WorkPhoneNumber": "sample string 5",
      "HomePhoneNumber": "sample string 6",
      "Mobile1PhoneNumber": "sample string 7",
      "Mobile2PhoneNumber": "sample string 8",
      "FaxPhoneNumber": "sample string 9",
      "BirthDate": "2023-01-30T12:19:57.3153983-10:00",
      "CitizenCountryId": 1,
      "BirthCountryId": 1,
      "Fein": "sample string 10",
      "YearStarted": 1,
      "EstablishCountryId": 1
    }
  ]
}

application/xml, text/xml

Sample:
<CustomerSearchListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Data>
    <CustomerClearanceOutboundDTO>
      <Id>2</Id>
      <BirthCountryId>1</BirthCountryId>
      <BirthDate>2023-01-30T12:19:57.3153983-10:00</BirthDate>
      <CitizenCountryId>1</CitizenCountryId>
      <CustomerType>Unknown</CustomerType>
      <EstablishCountryId>1</EstablishCountryId>
      <FaxPhoneNumber>sample string 9</FaxPhoneNumber>
      <Fein>sample string 10</Fein>
      <FullName>sample string 1</FullName>
      <HomeAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </HomeAddress>
      <HomePhoneNumber>sample string 6</HomePhoneNumber>
      <MailingAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </MailingAddress>
      <Mobile1PhoneNumber>sample string 7</Mobile1PhoneNumber>
      <Mobile2PhoneNumber>sample string 8</Mobile2PhoneNumber>
      <PrimaryEmailAddress>sample string 3</PrimaryEmailAddress>
      <RiskAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </RiskAddress>
      <SecondaryEmailAddress>sample string 4</SecondaryEmailAddress>
      <WorkAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </WorkAddress>
      <WorkPhoneNumber>sample string 5</WorkPhoneNumber>
      <YearStarted>1</YearStarted>
    </CustomerClearanceOutboundDTO>
    <CustomerClearanceOutboundDTO>
      <Id>2</Id>
      <BirthCountryId>1</BirthCountryId>
      <BirthDate>2023-01-30T12:19:57.3153983-10:00</BirthDate>
      <CitizenCountryId>1</CitizenCountryId>
      <CustomerType>Unknown</CustomerType>
      <EstablishCountryId>1</EstablishCountryId>
      <FaxPhoneNumber>sample string 9</FaxPhoneNumber>
      <Fein>sample string 10</Fein>
      <FullName>sample string 1</FullName>
      <HomeAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </HomeAddress>
      <HomePhoneNumber>sample string 6</HomePhoneNumber>
      <MailingAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </MailingAddress>
      <Mobile1PhoneNumber>sample string 7</Mobile1PhoneNumber>
      <Mobile2PhoneNumber>sample string 8</Mobile2PhoneNumber>
      <PrimaryEmailAddress>sample string 3</PrimaryEmailAddress>
      <RiskAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </RiskAddress>
      <SecondaryEmailAddress>sample string 4</SecondaryEmailAddress>
      <WorkAddress xmlns:d4p1="http://schemas.datacontract.org/2004/07/GCApi.Models">
        <d4p1:Expand></d4p1:Expand>
        <d4p1:Expansions xmlns:d5p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
        <d4p1:Id>9</d4p1:Id>
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 5</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zipcode1>sample string 7</d4p1:Zipcode1>
        <d4p1:Zipcode2>sample string 8</d4p1:Zipcode2>
        <d4p1:Type>Unknown</d4p1:Type>
      </WorkAddress>
      <WorkPhoneNumber>sample string 5</WorkPhoneNumber>
      <YearStarted>1</YearStarted>
    </CustomerClearanceOutboundDTO>
  </Data>
  <Limit>1</Limit>
  <Offset>1</Offset>
  <Total>1</Total>
</CustomerSearchListResponse>