complyadvantage

README

complyadvantage

SDK for https://app.complyadvantage.com/search-management#/search/1511261732-6KZaHQ2q

Documentation

Index

• Constants
• type AkaNames
• type Associate
• type BaseResponse
• type CertificateResponse
• type Client
  • func NewClient(apiKey string) *Client
  • func (c *Client) Searches(request *SearchesRequest) (*SearchResponse, error)
  • func (c *Client) SearchesById(id uint) (*SearchResponse, error)
  • func (c *Client) SearchesByIdCert(id uint) ([]byte, error)
  • func (c *Client) SearchesByIdDetails(id uint) (*SearchResponse, error)
  • func (c *Client) SearchesByTerm(term string) (r *SearchResponse, err error)
  • func (c *Client) Users() (*UsersResponse, error)
• type Content
• type Entity
• type Field
• type Filter
• type Hit
• type JsonBool
• type Media
• type Request
• type Response
• type SearchObject
• type SearchProfile
• type SearchResponse
• type SearchResult
• type SearchString
• type SearchTerm
• type Searcher
• type SearchesRequest
• type SearchesResponse
• type Tags
• type User
• type UsersResponse

Constants

const (
	Users = "/users"

	Searches             = "/searches"
	SearchesById         = "/searches/%d"
	SearchesByIdCert     = "/searches/%d/certificate"
	SearchesByIdDetails  = "/searches/%d/details"
	SearchesByIdMonitors = "/searches/%d/monitors"
)

const (
	BaseUrl = "https://api.complyadvantage.com"
	ApiKey  = "api_key"
)

const (
	EntityTypePerson  = "person"
	EntityTypeCompany = "company"
)

Types

type AkaNames

type AkaNames struct {
	Name string `json:"name"`
}

type Associate

type Associate struct {
	Name        string `json:"name"`
	Association string `json:"association"`
}

type BaseResponse

type BaseResponse struct {
	Code    int     `json:"code"`
	Status  string  `json:"status"`
	Content Content `json:"content"`
	Message string  `json:"message"`
}

type CertificateResponse

type CertificateResponse struct {
	PdfData []byte
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(apiKey string) *Client

func (*Client) Searches

func (c *Client) Searches(request *SearchesRequest) (*SearchResponse, error)

func (*Client) SearchesById

func (c *Client) SearchesById(id uint) (*SearchResponse, error)

func (*Client) SearchesByIdCert

func (c *Client) SearchesByIdCert(id uint) ([]byte, error)

func (*Client) SearchesByIdDetails

func (c *Client) SearchesByIdDetails(id uint) (*SearchResponse, error)

func (*Client) SearchesByTerm

func (c *Client) SearchesByTerm(term string) (r *SearchResponse, err error)

func (*Client) Users

func (c *Client) Users() (*UsersResponse, error)

type Content

type Content struct {
	Data interface{} `json:"data"`
}

type Entity

type Entity struct {
	Id            string       `json:"id"`
	EntityType    string       `json:"entity_type"`
	LastUpdateUtc time.Time    `json:"last_update_utc"`
	Name          string       `json:"name"`
	FirstName     string       `json:"first_name"`
	MiddleName    string       `json:"middle_name"`
	LastName      string       `json:"last_name"`
	Sources       []string     `json:"sources"`
	Types         []string     `json:"types"`
	Fields        []*Field     `json:"fields"`
	Aka           []*AkaNames  `json:"aka"`
	Associates    []*Associate `json:"associates"`
	Media         []*Media     `json:"media"`
	IsWhitelisted bool         `json:"is_whitelisted"`
	MatchTypes    []string     `json:"match_types"`
	Score         float64      `json:"score"`
}

type Field

type Field struct {
	Locale string `json:"locale"`
	Name   string `json:"name"`
	Values string `json:"values"`
	Tag    string `json:"tag"`
	Source string `json:"source"`
}

type Filter

type Filter struct {
	Types     []string `json:"types"`
	BirthYear string   `json:"birth_year"`

	//// 1 or 0
	RemoveDeceased int `json:"remove_deceased"`

	Passport   string `json:"passport"`
	EntityType string `json:"entity_type"`

	ExactMatch bool    `json:"-"`
	Fuzziness  float64 `json:"-"`
}

type Hit

type Hit struct {
	Doc Entity `json:"doc"`
}

type JsonBool

type JsonBool int

1 or 0

type Media

type Media struct {
	Date    time.Time `json:"date"`
	PdfUrl  string    `json:"pdf_url"`
	Snippet string    `json:"snippet"`
	Title   string    `json:"title"`
	Url     string    `json:"url"`
}

type Request

type Request interface{}

type Response

type Response interface{}

type SearchObject

type SearchObject struct {
	LastName   string `json:"last_name"`
	MiddleName string `json:"middle_name"`
	FirstName  string `json:"first_name"`
}

type SearchProfile

type SearchProfile struct {
	Name string `json:"name"`
	Slug string `json:"slug"`
}

type SearchResponse

type SearchResponse struct {
	BaseResponse
	Content struct {
		Data SearchResult `json:"data"`
	} `json:"content"`
}

type SearchResult

type SearchResult struct {
	Id            uint           `json:"id"`
	Ref           string         `json:"ref"`
	SearcherId    uint           `json:"searcher_id"`
	Searcher      Searcher       `json:"assignee"`
	Assignee      Searcher       `json:"assignee"`
	AssigneeId    uint           `json:"assignee_id"`
	SearchProfile *SearchProfile `json:"search_profile"`
	Filters       *Filter        `json:"filters"`
	MatchStatus   string         `json:"match_status"`
	RiskLevel     string         `json:"risk_level"`
	SearchTerm    string         `json:"search_term"`
	TotalHits     uint           `json:"total_hits"`
	UpdatedAt     string         `json:"updated_at"`
	CreatedAt     string         `json:"created_at"`
	Tags          *Tags          `json:"tags"`
	Hits          []Hit          `json:"hits"`
	ShareUrl      string         `json:"share_url"`
}

type SearchString

type SearchString string

type SearchTerm

type SearchTerm interface{}

type Searcher

type Searcher struct {
	Id        string `json:"id"`
	Email     string `json:"email"`
	Name      string `json:"name"`
	Phone     string `json:"phone"`
	UpdatedAt string `json:"updated_at"`
	CreatedAt string `json:"created_at"`
}

type SearchesRequest

type SearchesRequest struct {
	// required
	SearchTerm    SearchTerm        `json:"search_term"`
	ClientRef     string            `json:"client_ref"`
	SearchProfile string            `json:"search_profile"`
	Fuzziness     float64           `json:"fuzziness"`
	Offset        int               `json:"offset"`
	Limit         int               `json:"limit"`
	Filters       *Filter           `json:"filters"`
	Tags          map[string]string `json:"tags"`
}

type SearchesResponse

type SearchesResponse struct {
	BaseResponse
	Content struct {
		Data []SearchResult `json:"data"`
	} `json:"content"`
}

type Tags

type Tags struct {
	Name interface{}
}

type User

type User struct {
	Id        uint   `json:"id"`
	Email     string `json:"email"`
	Name      string `json:"name"`
	Phone     string `json:"phone"`
	UpdatedAt string `json:"updated_at"`
	CreatedAt string `json:"created_at"`
}

type UsersResponse

type UsersResponse struct {
	BaseResponse
	Content struct {
		Data []User `json:"data"`
	} `json:"content"`
}