client

package
v0.31.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 13, 2025 License: Apache-2.0 Imports: 23 Imported by: 0

README

Go API client for client

Moov Watchman offers download, parse, and search functions over numerous U.S. trade sanction lists for complying with regional laws. Also included is a web UI and async webhook notification service to initiate processes on remote systems.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/moov-io/watchman

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./client"

Documentation for API Endpoints

All URIs are relative to http://localhost:8084

Class Method HTTP request Description
WatchmanApi GetLatestDownloads Get /downloads Get latest downloads
WatchmanApi GetSDNAddresses Get /ofac/sdn/{sdnID}/addresses Get SDN addresses
WatchmanApi GetSDNAltNames Get /ofac/sdn/{sdnID}/alts Get SDN alt names
WatchmanApi GetUIValues Get /ui/values/{key} Get UI values
WatchmanApi Ping Get /ping Ping Watchman service
WatchmanApi Search Get /search Search
WatchmanApi SearchUSCSL Get /search/us-csl Search US CSL

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	WatchmanApi *WatchmanApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Watchman API API vv1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BisEntities 

type BisEntities struct {
	// The name of the entity
	Name string `json:"name,omitempty"`
	// Addresses associated with the entity
	Addresses []string `json:"addresses,omitempty"`
	// Known aliases associated with the entity
	AlternateNames []string `json:"alternateNames,omitempty"`
	// Date when the restriction came into effect
	StartDate string `json:"startDate,omitempty"`
	// Specifies the license requirement imposed on the named entity
	LicenseRequirement string `json:"licenseRequirement,omitempty"`
	// Identifies the policy BIS uses to review the licenseRequirements
	LicensePolicy string `json:"licensePolicy,omitempty"`
	// Identifies the corresponding Notice in the Federal Register
	FrNotice string `json:"frNotice,omitempty"`
	// The link to the official SSI list
	SourceListURL string `json:"sourceListURL,omitempty"`
	// The link for information regarding the source
	SourceInfoURL string `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

BisEntities Bureau of Industry and Security Entity List

type CaptaList added in v0.23.0 

type CaptaList struct {
	EntityID       string   `json:"entityID,omitempty"`
	EntityNumber   string   `json:"entityNumber,omitempty"`
	Type           string   `json:"type,omitempty"`
	Programs       []string `json:"programs,omitempty"`
	Name           string   `json:"name,omitempty"`
	Addresses      []string `json:"addresses,omitempty"`
	Remarks        []string `json:"remarks,omitempty"`
	SourceListURL  string   `json:"sourceListURL,omitempty"`
	AlternateNames []string `json:"alternateNames,omitempty"`
	SourceInfoURL  string   `json:"sourceInfoURL,omitempty"`
	IDs            []string `json:"IDs,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

CaptaList struct for CaptaList

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl added in v0.14.0 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type Download 

type Download struct {
	SDNs              int32     `json:"SDNs,omitempty"`
	AltNames          int32     `json:"altNames,omitempty"`
	Addresses         int32     `json:"addresses,omitempty"`
	SectoralSanctions int32     `json:"sectoralSanctions,omitempty"`
	DeniedPersons     int32     `json:"deniedPersons,omitempty"`
	BisEntities       int32     `json:"bisEntities,omitempty"`
	Timestamp         time.Time `json:"timestamp,omitempty"`
}

Download Metadata and stats about downloaded OFAC data

type Dpl 

type Dpl struct {
	// Denied Person's name
	Name string `json:"name,omitempty"`
	// Denied Person's street address
	StreetAddress string `json:"streetAddress,omitempty"`
	// Denied Person's city
	City string `json:"city,omitempty"`
	// Denied Person's state
	State string `json:"state,omitempty"`
	// Denied Person's country
	Country string `json:"country,omitempty"`
	// Denied Person's postal code
	PostalCode string `json:"postalCode,omitempty"`
	// Date when denial came into effect
	EffectiveDate string `json:"effectiveDate,omitempty"`
	// Date when denial expires, if blank denial never expires
	ExpirationDate string `json:"expirationDate,omitempty"`
	// Denotes whether or not the Denied Person was added by a standard order
	StandardOrder string `json:"standardOrder,omitempty"`
	// Date when the Denied Person's record was most recently updated
	LastUpdate string `json:"lastUpdate,omitempty"`
	// Most recent action taken regarding the denial
	Action string `json:"action,omitempty"`
	// Reference to the order's citation in the Federal Register
	FrCitation string `json:"frCitation,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

Dpl BIS Denied Persons List item

type Error 

type Error struct {
	// An error message describing the problem intended for humans.
	Error string `json:"error"`
}

Error struct for Error

type EuConsolidatedSanctionsList added in v0.24.0 

type EuConsolidatedSanctionsList struct {
	FileGenerationDate         string                 `json:"fileGenerationDate,omitempty"`
	EntityLogicalId            int32                  `json:"entityLogicalId,omitempty"`
	EntityRemark               string                 `json:"entityRemark,omitempty"`
	EntitySubjectType          string                 `json:"entitySubjectType,omitempty"`
	EntityPublicationURL       string                 `json:"entityPublicationURL,omitempty"`
	EntityReferenceNumber      string                 `json:"entityReferenceNumber,omitempty"`
	NameAliasWholeNames        []string               `json:"nameAliasWholeNames,omitempty"`
	NameAliasTitles            []string               `json:"nameAliasTitles,omitempty"`
	AddressCities              []string               `json:"addressCities,omitempty"`
	AddressStreets             []string               `json:"addressStreets,omitempty"`
	AddressPoBoxes             []string               `json:"addressPoBoxes,omitempty"`
	AddressZipCodes            []string               `json:"addressZipCodes,omitempty"`
	AddressCountryDescriptions []string               `json:"addressCountryDescriptions,omitempty"`
	BirthDates                 []string               `json:"birthDates,omitempty"`
	BirthCities                []string               `json:"birthCities,omitempty"`
	BirthCountries             []string               `json:"birthCountries,omitempty"`
	ValidFromTo                map[string]interface{} `json:"validFromTo,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

EuConsolidatedSanctionsList struct for EuConsolidatedSanctionsList

type ForeignSanctionsEvader added in v0.23.0 

type ForeignSanctionsEvader struct {
	EntityID      string   `json:"entityID,omitempty"`
	EntityNumber  string   `json:"entityNumber,omitempty"`
	Type          string   `json:"type,omitempty"`
	Programs      []string `json:"programs,omitempty"`
	Name          string   `json:"name,omitempty"`
	Addresses     []string `json:"addresses,omitempty"`
	SourceListURL string   `json:"sourceListURL,omitempty"`
	Citizenships  string   `json:"citizenships,omitempty"`
	DatesOfBirth  string   `json:"datesOfBirth,omitempty"`
	SourceInfoURL string   `json:"sourceInfoURL,omitempty"`
	IDs           []string `json:"IDs,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

ForeignSanctionsEvader struct for ForeignSanctionsEvader

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetLatestDownloadsOpts 

type GetLatestDownloadsOpts struct {
	XRequestID optional.String
	Limit      optional.Int32
}

GetLatestDownloadsOpts Optional parameters for the method 'GetLatestDownloads'

type GetSDNAddressesOpts 

type GetSDNAddressesOpts struct {
	XRequestID optional.String
}

GetSDNAddressesOpts Optional parameters for the method 'GetSDNAddresses'

type GetSDNAltNamesOpts 

type GetSDNAltNamesOpts struct {
	XRequestID optional.String
}

GetSDNAltNamesOpts Optional parameters for the method 'GetSDNAltNames'

type GetUIValuesOpts 

type GetUIValuesOpts struct {
	Limit optional.Int32
}

GetUIValuesOpts Optional parameters for the method 'GetUIValues'

type ItarDebarred added in v0.23.0 

type ItarDebarred struct {
	EntityID              string   `json:"entityID,omitempty"`
	Name                  string   `json:"name,omitempty"`
	FederalRegisterNotice string   `json:"federalRegisterNotice,omitempty"`
	SourceListURL         string   `json:"sourceListURL,omitempty"`
	AlternateNames        []string `json:"alternateNames,omitempty"`
	SourceInfoURL         string   `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

ItarDebarred struct for ItarDebarred

type MilitaryEndUser added in v0.23.0 

type MilitaryEndUser struct {
	EntityID  string `json:"entityID,omitempty"`
	Name      string `json:"name,omitempty"`
	Addresses string `json:"addresses,omitempty"`
	FRNotice  string `json:"FRNotice,omitempty"`
	StartDate string `json:"startDate,omitempty"`
	EndDate   string `json:"endDate,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

MilitaryEndUser struct for MilitaryEndUser

type NonProliferationSanction added in v0.23.0 

type NonProliferationSanction struct {
	EntityID              string   `json:"entityID,omitempty"`
	Programs              []string `json:"programs,omitempty"`
	Name                  string   `json:"name,omitempty"`
	FederalRegisterNotice string   `json:"federalRegisterNotice,omitempty"`
	StartDate             string   `json:"startDate,omitempty"`
	Remarks               []string `json:"remarks,omitempty"`
	SourceListURL         string   `json:"sourceListURL,omitempty"`
	AlternateNames        []string `json:"alternateNames,omitempty"`
	SourceInfoURL         string   `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

NonProliferationSanction struct for NonProliferationSanction

type NonSdnChineseMilitaryIndustrialComplex added in v0.23.0 

type NonSdnChineseMilitaryIndustrialComplex struct {
	EntityID       string   `json:"entityID,omitempty"`
	EntityNumber   string   `json:"entityNumber,omitempty"`
	Type           string   `json:"type,omitempty"`
	Programs       []string `json:"programs,omitempty"`
	Name           string   `json:"name,omitempty"`
	Addresses      []string `json:"addresses,omitempty"`
	Remarks        []string `json:"remarks,omitempty"`
	SourceListURL  string   `json:"sourceListURL,omitempty"`
	AlternateNames []string `json:"alternateNames,omitempty"`
	SourceInfoURL  string   `json:"sourceInfoURL,omitempty"`
	IDs            []string `json:"IDs,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

NonSdnChineseMilitaryIndustrialComplex struct for NonSdnChineseMilitaryIndustrialComplex

type NonSdnMenuBasedSanctionsList added in v0.23.0 

type NonSdnMenuBasedSanctionsList struct {
	EntityID       string   `json:"EntityID,omitempty"`
	EntityNumber   string   `json:"EntityNumber,omitempty"`
	Type           string   `json:"Type,omitempty"`
	Programs       []string `json:"Programs,omitempty"`
	Name           string   `json:"Name,omitempty"`
	Addresses      []string `json:"Addresses,omitempty"`
	Remarks        []string `json:"Remarks,omitempty"`
	AlternateNames []string `json:"AlternateNames,omitempty"`
	SourceInfoURL  string   `json:"SourceInfoURL,omitempty"`
	IDs            []string `json:"IDs,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

NonSdnMenuBasedSanctionsList struct for NonSdnMenuBasedSanctionsList

type OfacAlt 

type OfacAlt struct {
	EntityID         string `json:"entityID,omitempty"`
	AlternateID      string `json:"alternateID,omitempty"`
	AlternateType    string `json:"alternateType,omitempty"`
	AlternateName    string `json:"alternateName,omitempty"`
	AlternateRemarks string `json:"alternateRemarks,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

OfacAlt Alternate name from OFAC list

type OfacEntityAddress 

type OfacEntityAddress struct {
	EntityID                    string `json:"entityID,omitempty"`
	AddressID                   string `json:"addressID,omitempty"`
	Address                     string `json:"address,omitempty"`
	CityStateProvincePostalCode string `json:"cityStateProvincePostalCode,omitempty"`
	Country                     string `json:"country,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
}

OfacEntityAddress Physical address from OFAC list

type OfacSdn 

type OfacSdn struct {
	EntityID string  `json:"entityID,omitempty"`
	SdnName  string  `json:"sdnName,omitempty"`
	SdnType  SdnType `json:"sdnType,omitempty"`
	// Programs is the sanction programs this SDN was added from
	Programs []string `json:"programs,omitempty"`
	Title    string   `json:"title,omitempty"`
	// Remarks on SDN and often additional information about the SDN
	Remarks string `json:"remarks,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

OfacSdn Specially designated national from OFAC list

type PalestinianLegislativeCouncil added in v0.23.0 

type PalestinianLegislativeCouncil struct {
	EntityID       string   `json:"entityID,omitempty"`
	EntityNumber   string   `json:"entityNumber,omitempty"`
	Type           string   `json:"type,omitempty"`
	Programs       []string `json:"programs,omitempty"`
	Name           string   `json:"name,omitempty"`
	Addresses      []string `json:"addresses,omitempty"`
	Remarks        string   `json:"remarks,omitempty"`
	SourceListURL  string   `json:"sourceListURL,omitempty"`
	AlternateNames []string `json:"alternateNames,omitempty"`
	DatesOfBirth   string   `json:"datesOfBirth,omitempty"`
	PlacesOfBirth  string   `json:"placesOfBirth,omitempty"`
	SourceInfoURL  string   `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

PalestinianLegislativeCouncil struct for PalestinianLegislativeCouncil

type SdnType added in v0.16.0 

type SdnType string

SdnType Used for classifying SDNs — typically represents an individual or company 

const (
	SDNTYPE_INDIVIDUAL SdnType = "individual"
	SDNTYPE_ENTITY     SdnType = "entity"
	SDNTYPE_VESSEL     SdnType = "vessel"
	SDNTYPE_AIRCRAFT   SdnType = "aircraft"
)

List of SdnType 

type Search struct {
	SDNs                                   []OfacSdn                                `json:"SDNs,omitempty"`
	AltNames                               []OfacAlt                                `json:"altNames,omitempty"`
	Addresses                              []OfacEntityAddress                      `json:"addresses,omitempty"`
	DeniedPersons                          []Dpl                                    `json:"deniedPersons,omitempty"`
	BisEntities                            []BisEntities                            `json:"bisEntities,omitempty"`
	MilitaryEndUsers                       []MilitaryEndUser                        `json:"militaryEndUsers,omitempty"`
	SectoralSanctions                      []Ssi                                    `json:"sectoralSanctions,omitempty"`
	UnverifiedCSL                          []Unverified                             `json:"unverifiedCSL,omitempty"`
	NonproliferationSanctions              []NonProliferationSanction               `json:"nonproliferationSanctions,omitempty"`
	ForeignSanctionsEvaders                []ForeignSanctionsEvader                 `json:"foreignSanctionsEvaders,omitempty"`
	PalestinianLegislativeCouncil          []PalestinianLegislativeCouncil          `json:"palestinianLegislativeCouncil,omitempty"`
	CaptaList                              []CaptaList                              `json:"captaList,omitempty"`
	ItarDebarred                           []ItarDebarred                           `json:"itarDebarred,omitempty"`
	NonSDNChineseMilitaryIndustrialComplex []NonSdnChineseMilitaryIndustrialComplex `json:"nonSDNChineseMilitaryIndustrialComplex,omitempty"`
	NonSDNMenuBasedSanctionsList           []NonSdnMenuBasedSanctionsList           `json:"nonSDNMenuBasedSanctionsList,omitempty"`
	EuConsolidatedSanctionsList            []EuConsolidatedSanctionsList            `json:"euConsolidatedSanctionsList,omitempty"`
	UkConsolidatedSanctionsList            []UkConsolidatedSanctionsList            `json:"ukConsolidatedSanctionsList,omitempty"`
	UkSanctionsList                        []UkSanctionsList                        `json:"ukSanctionsList,omitempty"`
	RefreshedAt                            time.Time                                `json:"refreshedAt,omitempty"`
}

Search Search results containing SDNs, alternate names, and/or addreses

type SearchOpts 

type SearchOpts struct {
	XRequestID optional.String
	Q          optional.String
	Name       optional.String
	Address    optional.String
	City       optional.String
	State      optional.String
	Providence optional.String
	Zip        optional.String
	Country    optional.String
	AltName    optional.String
	Id         optional.String
	MinMatch   optional.Float32
	Limit      optional.Int32
	SdnType    optional.Interface
	Program    optional.String
}

SearchOpts Optional parameters for the method 'Search'

type SearchUSCSLOpts added in v0.23.0 

type SearchUSCSLOpts struct {
	XRequestID optional.String
	Name       optional.String
	Limit      optional.Int32
}

SearchUSCSLOpts Optional parameters for the method 'SearchUSCSL'

type ServerConfiguration added in v0.14.0 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable added in v0.14.0 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Ssi 

type Ssi struct {
	// The ID assigned to an entity by the Treasury Department
	EntityID string  `json:"entityID,omitempty"`
	Type     SsiType `json:"type,omitempty"`
	// Sanction programs for which the entity is flagged
	Programs []string `json:"programs,omitempty"`
	// The name of the entity
	Name string `json:"name,omitempty"`
	// Addresses associated with the entity
	Addresses []string `json:"addresses,omitempty"`
	// Additional details regarding the entity
	Remarks []string `json:"remarks,omitempty"`
	// Known aliases associated with the entity
	AlternateNames []string `json:"alternateNames,omitempty"`
	// IDs on file for the entity
	Ids []string `json:"ids,omitempty"`
	// The link to the official SSI list
	SourceListURL string `json:"sourceListURL,omitempty"`
	// The link for information regarding the source
	SourceInfoURL string `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

Ssi Treasury Department Sectoral Sanctions Identifications List (SSI)

type SsiType added in v0.16.0 

type SsiType string

SsiType Used for classifying SSIs 

const (
	SSITYPE_INDIVIDUAL SsiType = "individual"
	SSITYPE_ENTITY     SsiType = "entity"
)

List of SsiType

type UkConsolidatedSanctionsList added in v0.24.0 

type UkConsolidatedSanctionsList struct {
	Names     []string `json:"names,omitempty"`
	Addresses []string `json:"addresses,omitempty"`
	Countries []string `json:"countries,omitempty"`
	GroupType string   `json:"groupType,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

UkConsolidatedSanctionsList struct for UkConsolidatedSanctionsList

type UkSanctionsList added in v0.24.0 

type UkSanctionsList struct {
	Names            []string `json:"names,omitempty"`
	NonLatinNames    []string `json:"nonLatinNames,omitempty"`
	EntityType       string   `json:"entityType,omitempty"`
	Addresses        []string `json:"addresses,omitempty"`
	AddressCountries []string `json:"addressCountries,omitempty"`
	StateLocalities  []string `json:"stateLocalities,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

UkSanctionsList struct for UkSanctionsList

type Unverified added in v0.23.0 

type Unverified struct {
	EntityID      string   `json:"entityID,omitempty"`
	Name          string   `json:"name,omitempty"`
	Addresses     []string `json:"addresses,omitempty"`
	SourceListURL string   `json:"sourceListURL,omitempty"`
	SourceInfoURL string   `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
	// The highest scoring term from the search query. This term is the precomputed indexed value used by the search algorithm.
	MatchedName string `json:"matchedName,omitempty"`
}

Unverified struct for Unverified

type WatchmanApiService 

type WatchmanApiService service

WatchmanApiService WatchmanApi service

func (*WatchmanApiService) GetLatestDownloads 

func (a *WatchmanApiService) GetLatestDownloads(ctx _context.Context, localVarOptionals *GetLatestDownloadsOpts) ([]Download, *_nethttp.Response, error)

GetLatestDownloads Get latest downloads Return list of recent downloads of list data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetLatestDownloadsOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "Limit" (optional.Int32) - Maximum number of downloads to return sorted by their timestamp in decending order.

@return []Download

func (*WatchmanApiService) GetSDNAddresses 

func (a *WatchmanApiService) GetSDNAddresses(ctx _context.Context, sdnID string, localVarOptionals *GetSDNAddressesOpts) ([]OfacEntityAddress, *_nethttp.Response, error)

GetSDNAddresses Get SDN addresses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sdnID SDN ID
  • @param optional nil or *GetSDNAddressesOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return []OfacEntityAddress

func (*WatchmanApiService) GetSDNAltNames 

func (a *WatchmanApiService) GetSDNAltNames(ctx _context.Context, sdnID string, localVarOptionals *GetSDNAltNamesOpts) ([]OfacAlt, *_nethttp.Response, error)

GetSDNAltNames Get SDN alt names

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sdnID SDN ID
  • @param optional nil or *GetSDNAltNamesOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return []OfacAlt

func (*WatchmanApiService) GetUIValues 

func (a *WatchmanApiService) GetUIValues(ctx _context.Context, key SdnType, localVarOptionals *GetUIValuesOpts) ([]SdnType, *_nethttp.Response, error)

GetUIValues Get UI values Return an ordered distinct list of keys for an SDN property.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key SDN property to lookup. Values are sdnType, ofacProgram
  • @param optional nil or *GetUIValuesOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - Maximum number of UI keys returned

@return []SdnType

func (*WatchmanApiService) Ping 

func (a *WatchmanApiService) Ping(ctx _context.Context) (*_nethttp.Response, error)

Ping Ping Watchman service Check if the Watchman service is running.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*WatchmanApiService) Search 

func (a *WatchmanApiService) Search(ctx _context.Context, localVarOptionals *SearchOpts) (Search, *_nethttp.Response, error)

Search Search

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "Q" (optional.String) - Search across Name, Alt Names, and SDN Address fields for all available sanctions lists. Entries may be returned in all response sub-objects.
  • @param "Name" (optional.String) - Name which could correspond to an entry on the SDN, Denied Persons, Sectoral Sanctions Identifications, or BIS Entity List sanctions lists. Alt names are also searched.
  • @param "Address" (optional.String) - Physical address which could correspond to a human on the SDN list. Only Address results will be returned.
  • @param "City" (optional.String) - City name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "State" (optional.String) - State name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "Providence" (optional.String) - Providence name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "Zip" (optional.String) - Zip code as desginated by SDN guidelines. Only Address results will be returned.
  • @param "Country" (optional.String) - Country name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "AltName" (optional.String) - Alternate name which could correspond to a human on the SDN list. Only Alt name results will be returned.
  • @param "Id" (optional.String) - ID value often found in remarks property of an SDN. Takes the form of 'No. NNNNN' as an alphanumeric value.
  • @param "MinMatch" (optional.Float32) - Match percentage that search query must obtain for results to be returned.
  • @param "Limit" (optional.Int32) - Maximum results returned by a search. Results are sorted by their match percentage in decending order.
  • @param "SdnType" (optional.Interface of SdnType) - Optional filter to only return SDNs whose type case-insensitively matches.
  • @param "Program" (optional.String) - Optional filter to only return SDNs whose program case-insensitively matches.

@return Search

func (*WatchmanApiService) SearchUSCSL added in v0.23.0 

func (a *WatchmanApiService) SearchUSCSL(ctx _context.Context, localVarOptionals *SearchUSCSLOpts) (Search, *_nethttp.Response, error)

SearchUSCSL Search US CSL Search the US Consolidated Screening List

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchUSCSLOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "Name" (optional.String) - Name which could correspond to an entry on the CSL
  • @param "Limit" (optional.Int32) - Maximum number of downloads to return sorted by their timestamp in decending order.

@return Search

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.