GetAccountbasedonSearchCriteria

This API allows you to search an account based on specified search criteria.

/api/v1/accounts/search

Request Body Parameters

AgentId Integer

Unique identifier of agent.
AgentCode String

Indicates code of agent.
Ids Integer

Collection of unique identifier of account.
AccountCodes String

Indicates codes of account.
AccountName String

Name of the account.
DisplayName String

Display name of the account.
Email String

Indicates email for the account.
PhoneNumber String

Phone number of account.
Emails String

Collection of emails.
PhoneNumbers string

Collection of phone number.
SocialNetworkIds String

Collections of social network IDs.
PageIndex Integer

Indicates index of pages.
PageSize Integer

Indicates Pagesize from collection.
SortDirection String

Sorting ascending or descending.
SortParameter String

Indicates sorting parameter.
StartsWith String

Indicates starts with character for filtering.
IndustryType String

Type of Industry.
FEIN String

Indicates FEIN Number.
Address Object
Child Attributes
- AddressLine1 String
  
  Indicates address.
- AddressLine2 String
  
  Indicates address.
- City String
  
  Name of the city.
- State String
  
  Name of the state.
- PostalCode String
  
  Indicates postal code.
- County String
  
  Indicates county.
- Latitude Integer
  
  Indicates latitude position of address.
- Longitude Integer
  
  Indicates longitude position of address.
- AddressType String
  
  Indicates address type.
- AddressTypeId Integer
  
  Unique identifier of address type.
- UserProfileId Integer
  
  Unique identifier of user profile.
- ID Integer
  
  Unique identifier of address.
- Code String
  
  Indicates code of address.
- CreatedBy String
  
  Indicates user created.
- ModifiedBy String
  
  Indicates user modified.
- CreatedDate DateTime
  
  Indicates created date.
- ModifiedDate DateTime
  
  Indicates modified date.
LikeSearch Integer

Set to true if it is LikeSearch for filtering.
CreatedBy Integer

Indicates user created.
SEIN String

Indicates SEIN Number.
DuplicateCheck Boolean

Set to true for duplicate check.
VerifiedBy String

Indicates user verified.
CreatedDateFrom DateTime

Indicates date range.
CreatedDateTo DateTime

Indicates date range.

Response

AccountName String

Account name.
Type Object

Indicates user type object.
Since DateTime

Indicates the date when the account was created.
BusinessStarted DateTime

Indicates the date when the business was started.
SEIN String

Indicates SEIN number.
IndustryType String

Indicates type of industy.
NAICSCode String

Indicates NAICS code.
Income Double

Indicates income.
HomeOwnership String

Indicates home ownership.
Education String

Indicates education.
Occupation String

Indicates occupation.
MaritalStatus String

Indicates marital status.
NumberOfKids Integer

Number of kids.
ContactNamePrefix String

Indicates name prefix.
FEIN String

Indicates FEIN number.
DisplayName String

Indicates display name.
FirstName String

Indicates first name.
MiddleName String

Indicates middle name.
LastName String

Indicates last name.
Address Object
Child Attributes
- ID Integer
  
  Unique identifier of address.
- AddressLine1 String
  
  Indicates address.
- AddressLine2 String
  
  Indicates address.
- City String
  
  Name of the city.
- State String
  
  Name of the State.
- PostalCode String
  
  Indicates postal code.
- Latitude Integer
  
  Indicates latitude position of address.
- Longitude Integer
  
  Indicates longitude position of address.
- AddressType String
  
  Indicates address type.
- AddressTypeId Integer
  
  Unique identifier of address type.
- County String
  
  Indicates county.
Emails Object
Child Attributes
- ID Integer
  
  Unique identifier of email.
- UserProfileId Integer
  
  Unique identifier of user profile.
- EmailAddress String
  
  Indicates email address.
- EmailType String
  
  Indicates email type.
- EmailTypeId Integer
  
  Unique identifier of email type.
SocialNetWorks Object
Child Attributes
- ID Integer
  
  Unique identifier of social network.
- SocialNetworkType String
  
  Indicate type of social network.
- SocialNetworkId String
  
  Inidicates social network ID.
- AccessToken String
  
  Access token.
- AccessTokenSecret String
  
  Access token secret.
- ScreenName String
  
  Indicates screen name.
PhoneNumbers Object
Child Attributes
- ID Integer
  
  Unique identifier of phone number object.
- UserProfileId Integer
  
  Unique identifier of user profile.
- PhoneNumber String
  
  Phone number.
- PhoneType String
  
  Indicates type of phone.
AdditionalInfo String

Indicates additional information of account.
AccountContext Object
Child Attributes
- ParameterList Object
  Child Attributes
  
  Key String
  
  Indicates Key of parameter collection.
  
  Value String
  
  Indicates value of parameter collection.
Status String

Indicates status.
Description String

Indicates description.
Summary Object
Child Attributes
- parameters Object
  Child Attributes
  
  Value String
  
  Indicates value of parameter.
  
  Name String
  
  Indicates name of parameter.
- EntityType String
  
  Indicates entity type.
- EntityName String
  
  Indicates entity name.
TotalRecords Integer

Count of records.
ProspectId Integer

Unique identifier of prospect.
CustomerId Integer

Unique identifier of customer.
CustomerType Object

Collection of values (corportate or individual).
DoingBusinessAs String

Indicats business operations.
PrimaryState String

Indicates primary state.
LegalEntityType String

Indicates legal entity type.
EffectiveDate DateTime

Indicates start date.
IsMailingAddressAsPhysical Boolean

Set to true if it IsMailingAddressAsPhysical.
AgencyName String

Name of the agency.
AgentName String

Name of the agent.
AgentCode String

Code for agent.
PASAccountId Integer

Unique identifier of PAS account.
VerifiedBy String

Indicates verified by.
IsDirty Boolean

Set to true in edit mode.
ID Integer

Unique identifier of account.
Code String

Indicates code for account.
CreatedBy String

Indicates user created.
ModifiedBy String

Indicates user modified.
CreatedDate DateTime

Indicates creation date.
ModifiedDate DateTime

Indicates modified date.
IsLikeSearch Boolean

Set to true if it is LikeSearch for filtering.

Request

												{
  "AgentId": 0,
  "AgentCode": "string",
  "Ids": [
    0
  ],
  "AccountCodes": [
    "string"
  ],
  "AccountName": "string",
  "DisplayName": "string",
  "Email": "string",
  "PhoneNumber": "string",
  "Emails": [
    "string"
  ],
  "PhoneNumbers": [
    "string"
  ],
  "SocialNetworkIds": [
    "string"
  ],
  "PageIndex": 0,
  "PageSize": 0,
  "SortDirection": "Descending",
  "SortParameter": "string",
  "StartsWith": "string",
  "IndustryType": "string",
  "FEIN": "string",
  "Address": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "State": "string",
    "PostalCode": "string",
    "County": "string",
    "Latitude": 0,
    "Longitude": 0,
    "AddressType": "string",
    "AddressTypeId": 0,
    "UserProfileId": 0,
    "ID": 0,
    "Code": "string",
    "CreatedBy": "string",
    "ModifiedBy": "string",
    "CreatedDate": "2021-08-31T08:16:04.525Z",
    "ModifiedDate": "2021-08-31T08:16:04.525Z"
  },
  "LikeSearch": 0,
  "CreatedBy": 0,
  "SEIN": "string",
  "DuplicateCheck": true,
  "VerifiedBy": "string",
  "CreatedDateFrom": "2021-08-31T08:16:04.525Z",
  "CreatedDateTo": "2021-08-31T08:16:04.525Z"
}
                                                                    

Response

{
  "AccountName": "string",
  "Type": "Agent",
  "Since": "2021-07-02T10:08:08.198Z",
  "BusinessStarted": "2021-07-02T10:08:08.198Z",
  "SEIN": "string",
  "IndustryType": "string",
  "NAICSCode": "string",
  "Income": 0,
  "HomeOwnership": "string",
  "Education": "string",
  "Occupation": "string",
  "MaritalStatus": "string",
  "NumberOfKids": 0,
  "ContactNamePrefix": "string",
  "FEIN": "string",
  "DisplayName": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "Address": [
    {
      "ID": 0,
      "AddressLine1": "string",
      "AddressLine2": "string",
      "City": "string",
      "State": "string",
      "PostalCode": "string",
      "Latitude": 0,
      "Longitude": 0,
      "AddressType": "string",
      "AddressTypeId": 0,
      "County": "string"
    }
  ],
  "Emails": [
    {
      "ID": 0,
      "UserProfileId": 0,
      "EmailAddress": "string",
      "EmailType": "string",
      "EmailTypeId": 0
    }
  ],
  "SocialNetWorks": [
    {
      "ID": 0,
      "SocialNetworkType": "string",
      "SocialNetworkId": "string",
      "AccessToken": "string",
      "AccessTokenSecret": "string",
      "ScreenName": "string"
    }
  ],
  "PhoneNumbers": [
    {
      "ID": 0,
      "UserProfileId": 0,
      "PhoneNumber": "string",
      "PhoneType": "string"
    }
  ],
  "AdditionalInfo": "string",
  "AccountContext": {
    "ParameterList": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "Status": "string",
  "Description": "string",
  "Summary": {
    "parameters": [
      {
        "Value": "string",
        "Name": "string"
      }
    ],
    "EntityType": "string",
    "EntityName": "string"
  },
  "TotalRecords": 0,
  "ProspectId": 0,
  "CustomerId": 0,
  "CustomerType": "Corporate",
  "DoingBusinessAs": "string",
  "PrimaryState": "string",
  "LegalEntityType": "string",
  "EffectiveDate": "2021-07-02T10:08:08.198Z",
  "IsMailingAddressAsPhysical": true,
  "AgencyName": "string",
  "AgentName": "string",
  "AgentCode": "string",
  "PASAccountId": 0,
  "VerifiedBy": "string",
  "IsDirty": true,
  "ID": 0,
  "Code": "string",
  "CreatedBy": "string",
  "ModifiedBy": "string",
  "CreatedDate": "2021-07-02T10:08:08.198Z",
  "ModifiedDate": "2021-07-02T10:08:08.198Z",
  "IsLikeSearch": true
}

                                                                