check

package
v3.12.0 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2024 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RequestedCAMatchingStrategy added in v3.6.0 

type RequestedCAMatchingStrategy interface {
	Type() string
}

RequestedCAMatchingStrategy is the base type which other CA matching strategies must satisfy

type RequestedCASources added in v3.6.0 

type RequestedCASources interface {
	Type() string
	MarshalJSON() ([]byte, error)
}

RequestedCASources is the base type which other CA sources must satisfy

type RequestedCheck 

type RequestedCheck interface {
	Type() string
	Config() RequestedCheckConfig
	MarshalJSON() ([]byte, error)
}

RequestedCheck requests creation of a Check to be performed on a document

type RequestedCheckConfig 

type RequestedCheckConfig interface {
}

RequestedCheckConfig is the configuration applied when creating a Check

type RequestedDocumentAuthenticityCheck 

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

RequestedDocumentAuthenticityCheck requests creation of a Document Authenticity Check

func (*RequestedDocumentAuthenticityCheck) Config 

func (c *RequestedDocumentAuthenticityCheck) Config() RequestedCheckConfig

Config is the configuration of the Requested Check

func (*RequestedDocumentAuthenticityCheck) MarshalJSON 

func (c *RequestedDocumentAuthenticityCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (*RequestedDocumentAuthenticityCheck) Type 

func (c *RequestedDocumentAuthenticityCheck) Type() string

Type is the type of the Requested Check

type RequestedDocumentAuthenticityCheckBuilder 

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

RequestedDocumentAuthenticityCheckBuilder builds a RequestedDocumentAuthenticityCheck

Example 
docAuthCheck, err := NewRequestedDocumentAuthenticityCheckBuilder().WithManualCheckFallback().Build()

if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(docAuthCheck)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"type":"ID_DOCUMENT_AUTHENTICITY","config":{"manual_check":"FALLBACK"}}

func NewRequestedDocumentAuthenticityCheckBuilder 

func NewRequestedDocumentAuthenticityCheckBuilder() *RequestedDocumentAuthenticityCheckBuilder

NewRequestedDocumentAuthenticityCheckBuilder creates a new DocumentAuthenticityCheckBuilder

func (*RequestedDocumentAuthenticityCheckBuilder) Build 

func (b *RequestedDocumentAuthenticityCheckBuilder) Build() (*RequestedDocumentAuthenticityCheck, error)

Build builds the RequestedDocumentAuthenticityCheck

Example 
docAuthCheck, err := NewRequestedDocumentAuthenticityCheckBuilder().Build()

if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(docAuthCheck)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"type":"ID_DOCUMENT_AUTHENTICITY","config":{}}

func (*RequestedDocumentAuthenticityCheckBuilder) WithManualCheckAlways added in v3.2.0 

func (b *RequestedDocumentAuthenticityCheckBuilder) WithManualCheckAlways() *RequestedDocumentAuthenticityCheckBuilder

WithManualCheckAlways requires that a manual follow-up check is always performed

func (*RequestedDocumentAuthenticityCheckBuilder) WithManualCheckFallback added in v3.2.0 

func (b *RequestedDocumentAuthenticityCheckBuilder) WithManualCheckFallback() *RequestedDocumentAuthenticityCheckBuilder

WithManualCheckFallback requires that a manual follow-up check is performed only on failed Checks, and those with a low level of confidence

func (*RequestedDocumentAuthenticityCheckBuilder) WithManualCheckNever added in v3.2.0 

func (b *RequestedDocumentAuthenticityCheckBuilder) WithManualCheckNever() *RequestedDocumentAuthenticityCheckBuilder

WithManualCheckNever requires that only an automated Check is performed. No manual follow-up Check will ever be initiated

type RequestedDocumentAuthenticityConfig 

type RequestedDocumentAuthenticityConfig struct {
	ManualCheck string `json:"manual_check,omitempty"`
}

RequestedDocumentAuthenticityConfig is the configuration applied when creating a Document Authenticity Check

type RequestedExactMatchingStrategy added in v3.6.0 

type RequestedExactMatchingStrategy struct {
	RequestedCAMatchingStrategy
	ExactMatch bool
}

func (RequestedExactMatchingStrategy) MarshalJSON added in v3.6.0 

func (c RequestedExactMatchingStrategy) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

type RequestedFaceMatchCheck 

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

RequestedFaceMatchCheck requests creation of a FaceMatch Check

func (*RequestedFaceMatchCheck) Config 

func (c *RequestedFaceMatchCheck) Config() RequestedCheckConfig

Config is the configuration of the Requested Check

func (*RequestedFaceMatchCheck) MarshalJSON 

func (c *RequestedFaceMatchCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (*RequestedFaceMatchCheck) Type 

func (c *RequestedFaceMatchCheck) Type() string

Type is the type of the Requested Check

type RequestedFaceMatchCheckBuilder 

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

RequestedFaceMatchCheckBuilder builds a RequestedFaceMatchCheck

Example 
check, err := NewRequestedFaceMatchCheckBuilder().
	WithManualCheckNever().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(check)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"type":"ID_DOCUMENT_FACE_MATCH","config":{"manual_check":"NEVER"}}

func NewRequestedFaceMatchCheckBuilder 

func NewRequestedFaceMatchCheckBuilder() *RequestedFaceMatchCheckBuilder

NewRequestedFaceMatchCheckBuilder creates a new RequestedFaceMatchCheckBuilder

func (*RequestedFaceMatchCheckBuilder) Build 

func (b *RequestedFaceMatchCheckBuilder) Build() (*RequestedFaceMatchCheck, error)

Build builds the RequestedFaceMatchCheck

func (*RequestedFaceMatchCheckBuilder) WithManualCheckAlways 

func (b *RequestedFaceMatchCheckBuilder) WithManualCheckAlways() *RequestedFaceMatchCheckBuilder

WithManualCheckAlways sets the value of manual check to "ALWAYS"

func (*RequestedFaceMatchCheckBuilder) WithManualCheckFallback 

func (b *RequestedFaceMatchCheckBuilder) WithManualCheckFallback() *RequestedFaceMatchCheckBuilder

WithManualCheckFallback sets the value of manual check to "FALLBACK"

func (*RequestedFaceMatchCheckBuilder) WithManualCheckNever 

func (b *RequestedFaceMatchCheckBuilder) WithManualCheckNever() *RequestedFaceMatchCheckBuilder

WithManualCheckNever sets the value of manual check to "NEVER"

type RequestedFaceMatchConfig 

type RequestedFaceMatchConfig struct {
	ManualCheck string `json:"manual_check,omitempty"`
}

RequestedFaceMatchConfig is the configuration applied when creating a FaceMatch Check

type RequestedFuzzyMatchingStrategy added in v3.6.0 

type RequestedFuzzyMatchingStrategy struct {
	RequestedCAMatchingStrategy
	Fuzziness float64
}

func NewRequestedFuzzyMatchingStrategy added in v3.6.0 

func NewRequestedFuzzyMatchingStrategy() *RequestedFuzzyMatchingStrategy

func (RequestedFuzzyMatchingStrategy) MarshalJSON added in v3.6.0 

func (c RequestedFuzzyMatchingStrategy) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

type RequestedIDDocumentComparisonCheck added in v3.2.0 

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

RequestedIDDocumentComparisonCheck requests creation of a Document Comparison Check

func (*RequestedIDDocumentComparisonCheck) Config added in v3.2.0 

func (c *RequestedIDDocumentComparisonCheck) Config() RequestedCheckConfig

Config is the configuration of the Requested Check

func (*RequestedIDDocumentComparisonCheck) MarshalJSON added in v3.2.0 

func (c *RequestedIDDocumentComparisonCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (*RequestedIDDocumentComparisonCheck) Type added in v3.2.0 

func (c *RequestedIDDocumentComparisonCheck) Type() string

Type is the type of the Requested Check

type RequestedIDDocumentComparisonCheckBuilder added in v3.2.0 

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

RequestedIDDocumentComparisonCheckBuilder builds a RequestedIDDocumentComparisonCheck

func NewRequestedIDDocumentComparisonCheckBuilder added in v3.2.0 

func NewRequestedIDDocumentComparisonCheckBuilder() *RequestedIDDocumentComparisonCheckBuilder

NewRequestedIDDocumentComparisonCheckBuilder creates a new DocumentComparisonCheckBuilder

Example 
check, err := NewRequestedIDDocumentComparisonCheckBuilder().Build()

if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(check)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"type":"ID_DOCUMENT_COMPARISON","config":{}}

func (*RequestedIDDocumentComparisonCheckBuilder) Build added in v3.2.0 

func (b *RequestedIDDocumentComparisonCheckBuilder) Build() (*RequestedIDDocumentComparisonCheck, error)

Build builds the RequestedIDDocumentComparisonCheck

type RequestedIDDocumentComparisonConfig added in v3.2.0 

type RequestedIDDocumentComparisonConfig struct {
}

RequestedIDDocumentComparisonConfig is the configuration applied when creating a Document Comparison Check

type RequestedLivenessCheck 

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

RequestedLivenessCheck requests creation of a Liveness Check

func (*RequestedLivenessCheck) Config 

func (c *RequestedLivenessCheck) Config() RequestedCheckConfig

Config is the configuration of the Requested Check

func (*RequestedLivenessCheck) MarshalJSON 

func (c *RequestedLivenessCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (*RequestedLivenessCheck) Type 

func (c *RequestedLivenessCheck) Type() string

Type is the type of the Requested Check

type RequestedLivenessCheckBuilder 

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

RequestedLivenessCheckBuilder builds a RequestedLivenessCheck

Example 
check, err := NewRequestedLivenessCheckBuilder().
	ForZoomLiveness().
	WithMaxRetries(9).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(check)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"type":"LIVENESS","config":{"max_retries":9,"liveness_type":"ZOOM"}}

func NewRequestedLivenessCheckBuilder 

func NewRequestedLivenessCheckBuilder() *RequestedLivenessCheckBuilder

NewRequestedLivenessCheckBuilder creates a new RequestedLivenessCheckBuilder

func (*RequestedLivenessCheckBuilder) Build 

func (b *RequestedLivenessCheckBuilder) Build() (*RequestedLivenessCheck, error)

Build builds the RequestedLivenessCheck

func (*RequestedLivenessCheckBuilder) ForLivenessType 

func (b *RequestedLivenessCheckBuilder) ForLivenessType(livenessType string) *RequestedLivenessCheckBuilder

ForLivenessType sets the liveness type on the builder

func (*RequestedLivenessCheckBuilder) ForStaticLiveness added in v3.9.0 

func (b *RequestedLivenessCheckBuilder) ForStaticLiveness() *RequestedLivenessCheckBuilder

ForStaticLiveness sets the liveness type to "STATIC"

func (*RequestedLivenessCheckBuilder) ForZoomLiveness 

func (b *RequestedLivenessCheckBuilder) ForZoomLiveness() *RequestedLivenessCheckBuilder

ForZoomLiveness sets the liveness type to "ZOOM"

func (*RequestedLivenessCheckBuilder) WithManualCheckNever added in v3.9.0 

func (b *RequestedLivenessCheckBuilder) WithManualCheckNever() *RequestedLivenessCheckBuilder

WithManualCheckNever sets the value of manual check to "NEVER"

func (*RequestedLivenessCheckBuilder) WithMaxRetries 

func (b *RequestedLivenessCheckBuilder) WithMaxRetries(maxRetries int) *RequestedLivenessCheckBuilder

WithMaxRetries sets the maximum number of retries allowed for liveness check on the builder

type RequestedLivenessConfig 

type RequestedLivenessConfig struct {
	MaxRetries   int    `json:"max_retries,omitempty"`
	LivenessType string `json:"liveness_type,omitempty"`
	ManualCheck  string `json:"manual_check,omitempty"`
}

RequestedLivenessConfig is the configuration applied when creating a Liveness Check

type RequestedThirdPartyIdentityCheck added in v3.4.0 

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

RequestedThirdPartyIdentityCheck requests creation of a third party CRA check

Example 
thirdPartyCheck, err := NewRequestedThirdPartyIdentityCheckBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(thirdPartyCheck)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"type":"THIRD_PARTY_IDENTITY","config":{}}

func (*RequestedThirdPartyIdentityCheck) Config added in v3.4.0 

func (c *RequestedThirdPartyIdentityCheck) Config() RequestedCheckConfig

Config is the configuration of the requested check

func (*RequestedThirdPartyIdentityCheck) MarshalJSON added in v3.4.0 

func (c *RequestedThirdPartyIdentityCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (*RequestedThirdPartyIdentityCheck) Type added in v3.4.0 

func (c *RequestedThirdPartyIdentityCheck) Type() string

Type is the type of the requested check

type RequestedThirdPartyIdentityCheckBuilder added in v3.4.0 

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

RequestedThirdPartyIdentityCheckBuilder builds a RequestedThirdPartyIdentityCheck

func NewRequestedThirdPartyIdentityCheckBuilder added in v3.4.0 

func NewRequestedThirdPartyIdentityCheckBuilder() *RequestedThirdPartyIdentityCheckBuilder

NewRequestedThirdPartyIdentityCheckBuilder creates a new builder for RequestedThirdPartyIdentityCheck

func (*RequestedThirdPartyIdentityCheckBuilder) Build added in v3.4.0 

func (b *RequestedThirdPartyIdentityCheckBuilder) Build() (*RequestedThirdPartyIdentityCheck, error)

Build builds the RequestedThirdPartyIdentityCheck

type RequestedThirdPartyIdentityCheckConfig added in v3.4.0 

type RequestedThirdPartyIdentityCheckConfig struct {
}

RequestedThirdPartyIdentityCheckConfig is the configuration applied when creating a third party identity check

type RequestedTypeListSources added in v3.6.0 

type RequestedTypeListSources struct {
	RequestedCASources
	Types []string
}

func (RequestedTypeListSources) MarshalJSON added in v3.6.0 

func (c RequestedTypeListSources) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (RequestedTypeListSources) Type added in v3.6.0 

func (c RequestedTypeListSources) Type() string

Type is the type of the Requested Check

type RequestedWatchlistAdvancedCACheckCustomAccountBuilder added in v3.6.0 

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

func NewRequestedWatchlistAdvancedCACheckCustomAccountBuilder added in v3.6.0 

func NewRequestedWatchlistAdvancedCACheckCustomAccountBuilder() *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

func (RequestedWatchlistAdvancedCACheckCustomAccountBuilder) Build added in v3.6.0 

func (b RequestedWatchlistAdvancedCACheckCustomAccountBuilder) Build() (RequestedWatchlistAdvancedCACustomAccountCheck, error)
Example 
package main

import (
	"fmt"

	"github.com/getyoti/yoti-go-sdk/v3/docscan/session/create/check"
)

func main() {
	advancedCACustomAccountCheck, err := check.NewRequestedWatchlistAdvancedCACheckCustomAccountBuilder().
		WithAPIKey("api-key").
		WithMonitoring(true).
		WithTags(map[string]string{
			"tag_name": "value",
		}).
		WithClientRef("client-ref").
		WithMatchingStrategy(check.RequestedExactMatchingStrategy{ExactMatch: true}).
		Build()
	if err != nil {
		fmt.Printf("error: %s", err.Error())
		return
	}

	data, err := advancedCACustomAccountCheck.MarshalJSON()
	if err != nil {
		fmt.Printf("error: %s", err.Error())
		return
	}

	fmt.Println(string(data))
}

Output:

{"type":"WATCHLIST_ADVANCED_CA","config":{"type":"WITH_CUSTOM_ACCOUNT","matching_strategy":{"type":"EXACT","exact_match":true},"api_key":"api-key","monitoring":true,"tags":{"tag_name":"value"},"client_ref":"client-ref"}}

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithAPIKey added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithAPIKey(apiKey string) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

WithAPIKey sets the API key for the Watchlist Advanced CA check (custom account).

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithClientRef added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithClientRef(clientRef string) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

WithClientRef sets the client reference for the Watchlist Advanced CA check (custom account).

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithMatchingStrategy added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithMatchingStrategy(requestedCAMatchingStrategy RequestedCAMatchingStrategy) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithMonitoring added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithMonitoring(monitoring bool) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

WithMonitoring sets whether monitoring is used for the Watchlist Advanced CA check (custom account).

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithRemoveDeceased added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithRemoveDeceased(removeDeceased bool) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithShareURL added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithShareURL(shareURL bool) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithSources added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithSources(requestedCASources RequestedCASources) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

func (*RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithTags added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckCustomAccountBuilder) WithTags(tags map[string]string) *RequestedWatchlistAdvancedCACheckCustomAccountBuilder

WithTags sets tags used for custom account Watchlist Advanced CA check. Please note this will override any previously set tags

type RequestedWatchlistAdvancedCACheckYotiAccountBuilder added in v3.6.0 

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

func NewRequestedWatchlistAdvancedCACheckYotiAccountBuilder added in v3.6.0 

func NewRequestedWatchlistAdvancedCACheckYotiAccountBuilder() *RequestedWatchlistAdvancedCACheckYotiAccountBuilder

NewRequestedWatchlistAdvancedCACheckYotiAccountBuilder creates a new builder for RequestedWatchlistAdvancedCACheckYotiAccountBuilder

Example 
package main

import (
	"fmt"

	"github.com/getyoti/yoti-go-sdk/v3/docscan/session/create/check"
)

func main() {
	advancedCAYotiAccountCheck, err := check.NewRequestedWatchlistAdvancedCACheckYotiAccountBuilder().
		WithRemoveDeceased(true).
		WithShareURL(true).
		WithSources(check.RequestedTypeListSources{
			Types: []string{"pep", "fitness-probity", "warning"}}).
		WithMatchingStrategy(check.RequestedFuzzyMatchingStrategy{Fuzziness: 0.5}).
		Build()
	if err != nil {
		fmt.Printf("error: %s", err.Error())
		return
	}

	data, err := advancedCAYotiAccountCheck.MarshalJSON()
	if err != nil {
		fmt.Printf("error: %s", err.Error())
		return
	}

	fmt.Println(string(data))
}

Output:

{"type":"WATCHLIST_ADVANCED_CA","config":{"type":"WITH_YOTI_ACCOUNT","remove_deceased":true,"share_url":true,"sources":{"type":"TYPE_LIST","types":["pep","fitness-probity","warning"]},"matching_strategy":{"type":"FUZZY","fuzziness":0.5}}}

func (RequestedWatchlistAdvancedCACheckYotiAccountBuilder) Build added in v3.6.0 

func (b RequestedWatchlistAdvancedCACheckYotiAccountBuilder) Build() (RequestedWatchlistAdvancedCAYotiAccountCheck, error)

func (*RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithMatchingStrategy added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithMatchingStrategy(requestedCAMatchingStrategy RequestedCAMatchingStrategy) *RequestedWatchlistAdvancedCACheckYotiAccountBuilder

func (*RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithRemoveDeceased added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithRemoveDeceased(removeDeceased bool) *RequestedWatchlistAdvancedCACheckYotiAccountBuilder

func (*RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithShareURL added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithShareURL(shareURL bool) *RequestedWatchlistAdvancedCACheckYotiAccountBuilder

func (*RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithSources added in v3.6.0 

func (b *RequestedWatchlistAdvancedCACheckYotiAccountBuilder) WithSources(requestedCASources RequestedCASources) *RequestedWatchlistAdvancedCACheckYotiAccountBuilder

type RequestedWatchlistAdvancedCAConfig added in v3.6.0 

type RequestedWatchlistAdvancedCAConfig struct {
	Type             string                      `json:"type,omitempty"`
	RemoveDeceased   bool                        `json:"remove_deceased,omitempty"`
	ShareUrl         bool                        `json:"share_url,omitempty"`
	Sources          RequestedCASources          `json:"sources,omitempty"`
	MatchingStrategy RequestedCAMatchingStrategy `json:"matching_strategy,omitempty"`
}

type RequestedWatchlistAdvancedCACustomAccountCheck added in v3.6.0 

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

func (RequestedWatchlistAdvancedCACustomAccountCheck) Config added in v3.6.0 

func (c RequestedWatchlistAdvancedCACustomAccountCheck) Config() RequestedCheckConfig

Config is the configuration of the requested check

func (RequestedWatchlistAdvancedCACustomAccountCheck) MarshalJSON added in v3.6.0 

func (c RequestedWatchlistAdvancedCACustomAccountCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (RequestedWatchlistAdvancedCACustomAccountCheck) Type added in v3.6.0 

func (c RequestedWatchlistAdvancedCACustomAccountCheck) Type() string

Type is the type of the requested check

type RequestedWatchlistAdvancedCACustomAccountConfig added in v3.6.0 

type RequestedWatchlistAdvancedCACustomAccountConfig struct {
	RequestedWatchlistAdvancedCAConfig
	APIKey     string            `json:"api_key,omitempty"`
	Monitoring bool              `json:"monitoring,omitempty"`
	Tags       map[string]string `json:"tags,omitempty"`
	ClientRef  string            `json:"client_ref,omitempty"`
}

type RequestedWatchlistAdvancedCAYotiAccountCheck added in v3.6.0 

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

func (RequestedWatchlistAdvancedCAYotiAccountCheck) Config added in v3.6.0 

func (c RequestedWatchlistAdvancedCAYotiAccountCheck) Config() RequestedCheckConfig

Config is the configuration of the requested check

func (RequestedWatchlistAdvancedCAYotiAccountCheck) MarshalJSON added in v3.6.0 

func (c RequestedWatchlistAdvancedCAYotiAccountCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (RequestedWatchlistAdvancedCAYotiAccountCheck) Type added in v3.6.0 

func (c RequestedWatchlistAdvancedCAYotiAccountCheck) Type() string

Type is the type of the requested check

type RequestedWatchlistAdvancedCAYotiAccountConfig added in v3.6.0 

type RequestedWatchlistAdvancedCAYotiAccountConfig struct {
	RequestedWatchlistAdvancedCAConfig
}

type RequestedWatchlistScreeningCheck added in v3.6.0 

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

RequestedWatchlistScreeningCheck requests creation of a Watchlist Screening Check. To request a RequestedWatchlistScreeningCheck you must request task.RequestedTextExtractionTask as a minimum

func (*RequestedWatchlistScreeningCheck) Config added in v3.6.0 

func (c *RequestedWatchlistScreeningCheck) Config() RequestedCheckConfig

Config is the configuration of the requested check

func (*RequestedWatchlistScreeningCheck) MarshalJSON added in v3.6.0 

func (c *RequestedWatchlistScreeningCheck) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding

func (*RequestedWatchlistScreeningCheck) Type added in v3.6.0 

func (c *RequestedWatchlistScreeningCheck) Type() string

Type is the type of the requested check

type RequestedWatchlistScreeningCheckBuilder added in v3.6.0 

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

RequestedWatchlistScreeningCheckBuilder builds a RequestedWatchlistScreeningCheck

func NewRequestedWatchlistScreeningCheckBuilder added in v3.6.0 

func NewRequestedWatchlistScreeningCheckBuilder() *RequestedWatchlistScreeningCheckBuilder

NewRequestedWatchlistScreeningCheckBuilder creates a new builder for RequestedWatchlistScreeningCheck

Example 
watchlistScreeningCheck, err := NewRequestedWatchlistScreeningCheckBuilder().
	WithAdverseMediaCategory().
	WithSanctionsCategory().
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

data, err := json.Marshal(watchlistScreeningCheck)
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

fmt.Println(string(data))

Output:

{"type":"WATCHLIST_SCREENING","config":{"categories":["ADVERSE-MEDIA","SANCTIONS"]}}

func (*RequestedWatchlistScreeningCheckBuilder) Build added in v3.6.0 

func (b *RequestedWatchlistScreeningCheckBuilder) Build() (*RequestedWatchlistScreeningCheck, error)

Build builds the RequestedWatchlistScreeningCheck

func (*RequestedWatchlistScreeningCheckBuilder) WithAdverseMediaCategory added in v3.6.0 

func (b *RequestedWatchlistScreeningCheckBuilder) WithAdverseMediaCategory() *RequestedWatchlistScreeningCheckBuilder

WithAdverseMediaCategory adds ADVERSE_MEDIA to the list of categories used for watchlist screening

func (*RequestedWatchlistScreeningCheckBuilder) WithCategory added in v3.6.0 

func (b *RequestedWatchlistScreeningCheckBuilder) WithCategory(category string) *RequestedWatchlistScreeningCheckBuilder

WithCategory adds a category to the list of categories used for watchlist screening

func (*RequestedWatchlistScreeningCheckBuilder) WithSanctionsCategory added in v3.6.0 

func (b *RequestedWatchlistScreeningCheckBuilder) WithSanctionsCategory() *RequestedWatchlistScreeningCheckBuilder

WithSanctionsCategory adds SANCTIONS to the list of categories used for watchlist screening

type RequestedWatchlistScreeningCheckConfig added in v3.6.0 

type RequestedWatchlistScreeningCheckConfig struct {
	Categories []string `json:"categories"`
}

RequestedWatchlistScreeningCheckConfig is the configuration applied when creating a watchlist screening check

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.