Sanctions Search API: v2

GetValidIds

ValidID

The following routes are available for this service:
POST	/validid/list	Get all the ValidID Searches

**GetValidIds** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetValidIdsRequest	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserId	header, body	string	No	The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).

**GetValidIdsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
Page	form	int	No
SortOrder	form	string	No
NameSearch	form	string	No
FilterReference	form	string	No
FilterType	form	string	No
FilterDateFrom	form	DateTime?	No
FilterDateTo	form	DateTime?	No
FilterUserName	form	string	No	If set, will only return searches created by the user

**GetValidIdsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetValidIdsData	No

**GetValidIdsData** Parameters:
Name	Parameter	Data Type	Required
TotalSearchRecords	form	int	No
CurrentPageNum	form	int	No
MaxPageNum	form	int	No
SearchRecords	form	ArrayOfValidIdListItem	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**ValidIdListItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Type	form	int	No
Score	form	int?	No
Status	form	string	No
DateSearched	form	DateTime	No
Reference	form	string	No
PepError	form	bool	No
Replaced	form	bool	No
ReplacementSearchId	form	int?	No
HasCompletedRequest	form	bool	No
HasCompletedSearch	form	bool	No
SearchCriteria	form	ValidIdSearchCriteria	No

**ValidIdSearchCriteria** Parameters:
Name	Parameter	Data Type	Required
FullName	form	string	No
DateOfBirth	form	DateTime	No
Gender	form	string	No
Address	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /validid/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetValidIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
    <UserId>String</UserId>
  </Authentication>
  <Request>
    <FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
    <FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
    <FilterReference>String</FilterReference>
    <FilterType>String</FilterType>
    <FilterUserName>String</FilterUserName>
    <NameSearch>String</NameSearch>
    <Page>0</Page>
    <SortOrder>String</SortOrder>
    <SubUserName>String</SubUserName>
  </Request>
</GetValidIds>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetValidIdsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <CurrentPageNum>0</CurrentPageNum>
    <MaxPageNum>0</MaxPageNum>
    <SearchRecords>
      <SearchRecord>
        <DateSearched>0001-01-01T00:00:00</DateSearched>
        <HasCompletedRequest>false</HasCompletedRequest>
        <HasCompletedSearch>false</HasCompletedSearch>
        <Id>0</Id>
        <PepError>false</PepError>
        <Reference>String</Reference>
        <Replaced>false</Replaced>
        <ReplacementSearchId>0</ReplacementSearchId>
        <Score>0</Score>
        <SearchCriteria>
          <Address>String</Address>
          <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
          <FullName>String</FullName>
          <Gender>String</Gender>
        </SearchCriteria>
        <Status>String</Status>
        <Type>0</Type>
      </SearchRecord>
    </SearchRecords>
    <TotalSearchRecords>0</TotalSearchRecords>
  </Data>
</GetValidIdsResponse>