Documentation ¶
Index ¶
- type DocumentAuthenticityCheck
- type DocumentAuthenticityCheckBuilder
- func (b *DocumentAuthenticityCheckBuilder) Build() (*DocumentAuthenticityCheck, error)
- func (b *DocumentAuthenticityCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *DocumentAuthenticityCheckBuilder
- func (b *DocumentAuthenticityCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *DocumentAuthenticityCheckBuilder
- func (b *DocumentAuthenticityCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *DocumentAuthenticityCheckBuilder
- type DocumentFaceMatchCheck
- type DocumentFaceMatchCheckBuilder
- func (b *DocumentFaceMatchCheckBuilder) Build() (*DocumentFaceMatchCheck, error)
- func (b *DocumentFaceMatchCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *DocumentFaceMatchCheckBuilder
- func (b *DocumentFaceMatchCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *DocumentFaceMatchCheckBuilder
- func (b *DocumentFaceMatchCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *DocumentFaceMatchCheckBuilder
- type DocumentTextDataCheck
- type DocumentTextDataCheckBuilder
- func (b *DocumentTextDataCheckBuilder) Build() (*DocumentTextDataCheck, error)
- func (b *DocumentTextDataCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *DocumentTextDataCheckBuilder
- func (b *DocumentTextDataCheckBuilder) WithDocumentField(key string, value interface{}) *DocumentTextDataCheckBuilder
- func (b *DocumentTextDataCheckBuilder) WithDocumentFields(documentFields map[string]interface{}) *DocumentTextDataCheckBuilder
- func (b *DocumentTextDataCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *DocumentTextDataCheckBuilder
- func (b *DocumentTextDataCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *DocumentTextDataCheckBuilder
- type DocumentTextDataCheckResult
- type IDDocumentComparisonCheck
- type IDDocumentComparisonCheckBuilder
- func (b *IDDocumentComparisonCheckBuilder) Build() (*IDDocumentComparisonCheck, error)
- func (b *IDDocumentComparisonCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *IDDocumentComparisonCheckBuilder
- func (b *IDDocumentComparisonCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *IDDocumentComparisonCheckBuilder
- func (b *IDDocumentComparisonCheckBuilder) WithSecondaryDocumentFilter(filter *filter.DocumentFilter) *IDDocumentComparisonCheckBuilder
- type LivenessCheck
- type StaticLivenessCheckBuilder
- type SupplementaryDocumentTextDataCheck
- type SupplementaryDocumentTextDataCheckBuilder
- func (b *SupplementaryDocumentTextDataCheckBuilder) Build() (*SupplementaryDocumentTextDataCheck, error)
- func (b *SupplementaryDocumentTextDataCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *SupplementaryDocumentTextDataCheckBuilder
- func (b *SupplementaryDocumentTextDataCheckBuilder) WithDocumentField(key string, value interface{}) *SupplementaryDocumentTextDataCheckBuilder
- func (b *SupplementaryDocumentTextDataCheckBuilder) WithDocumentFields(documentFields map[string]interface{}) *SupplementaryDocumentTextDataCheckBuilder
- func (b *SupplementaryDocumentTextDataCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *SupplementaryDocumentTextDataCheckBuilder
- func (b *SupplementaryDocumentTextDataCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *SupplementaryDocumentTextDataCheckBuilder
- type SupplementaryDocumentTextDataCheckResult
- type ThirdPartyIdentityCheck
- type ThirdPartyIdentityCheckBuilder
- func (b *ThirdPartyIdentityCheckBuilder) Build() (*ThirdPartyIdentityCheck, error)
- func (b *ThirdPartyIdentityCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *ThirdPartyIdentityCheckBuilder
- func (b *ThirdPartyIdentityCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *ThirdPartyIdentityCheckBuilder
- type ZoomLivenessCheckBuilder
Examples ¶
- DocumentAuthenticityCheckBuilder
- DocumentFaceMatchCheckBuilder
- DocumentTextDataCheckBuilder
- DocumentTextDataCheckBuilder (Minimal)
- DocumentTextDataCheckBuilder.WithDocumentFields
- IDDocumentComparisonCheckBuilder
- IDDocumentComparisonCheckBuilder (Minimal)
- StaticLivenessCheckBuilder
- SupplementaryDocumentTextDataCheckBuilder
- SupplementaryDocumentTextDataCheckBuilder (Minimal)
- SupplementaryDocumentTextDataCheckBuilder.WithDocumentFields
- ThirdPartyIdentityCheckBuilder
- ZoomLivenessCheckBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocumentAuthenticityCheck ¶
type DocumentAuthenticityCheck struct {
// contains filtered or unexported fields
}
DocumentAuthenticityCheck Represents a document authenticity check
type DocumentAuthenticityCheckBuilder ¶
type DocumentAuthenticityCheckBuilder struct {
// contains filtered or unexported fields
}
DocumentAuthenticityCheckBuilder builds a DocumentAuthenticityCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } docFilter, err := filter.NewDocumentFilterBuilder().Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } check, err := NewDocumentAuthenticityCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). WithDocumentFilter(docFilter). 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: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}},"document_filter":{"document_types":[],"country_codes":[]}}
func NewDocumentAuthenticityCheckBuilder ¶
func NewDocumentAuthenticityCheckBuilder() *DocumentAuthenticityCheckBuilder
NewDocumentAuthenticityCheckBuilder creates a new DocumentAuthenticityCheckBuilder
func (*DocumentAuthenticityCheckBuilder) Build ¶
func (b *DocumentAuthenticityCheckBuilder) Build() (*DocumentAuthenticityCheck, error)
Build creates a new DocumentAuthenticityCheck
func (*DocumentAuthenticityCheckBuilder) WithBreakdown ¶
func (b *DocumentAuthenticityCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *DocumentAuthenticityCheckBuilder
WithBreakdown adds a breakdown item to the check
func (*DocumentAuthenticityCheckBuilder) WithDocumentFilter ¶
func (b *DocumentAuthenticityCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *DocumentAuthenticityCheckBuilder
WithDocumentFilter adds a document filter to the check
func (*DocumentAuthenticityCheckBuilder) WithRecommendation ¶
func (b *DocumentAuthenticityCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *DocumentAuthenticityCheckBuilder
WithRecommendation sets the recommendation on the check
type DocumentFaceMatchCheck ¶
type DocumentFaceMatchCheck struct {
// contains filtered or unexported fields
}
DocumentFaceMatchCheck represents a face match check
type DocumentFaceMatchCheckBuilder ¶
type DocumentFaceMatchCheckBuilder struct {
// contains filtered or unexported fields
}
DocumentFaceMatchCheckBuilder builds a DocumentFaceMatchCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } docFilter, err := filter.NewDocumentFilterBuilder().Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } check, err := NewDocumentFaceMatchCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). WithDocumentFilter(docFilter). 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: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}},"document_filter":{"document_types":[],"country_codes":[]}}
func NewDocumentFaceMatchCheckBuilder ¶
func NewDocumentFaceMatchCheckBuilder() *DocumentFaceMatchCheckBuilder
NewDocumentFaceMatchCheckBuilder creates a new DocumentFaceMatchCheckBuilder
func (*DocumentFaceMatchCheckBuilder) Build ¶
func (b *DocumentFaceMatchCheckBuilder) Build() (*DocumentFaceMatchCheck, error)
Build creates a new DocumentFaceMatchCheck
func (*DocumentFaceMatchCheckBuilder) WithBreakdown ¶
func (b *DocumentFaceMatchCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *DocumentFaceMatchCheckBuilder
WithBreakdown adds a breakdown item to the check
func (*DocumentFaceMatchCheckBuilder) WithDocumentFilter ¶
func (b *DocumentFaceMatchCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *DocumentFaceMatchCheckBuilder
WithDocumentFilter adds a document filter to the check
func (*DocumentFaceMatchCheckBuilder) WithRecommendation ¶
func (b *DocumentFaceMatchCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *DocumentFaceMatchCheckBuilder
WithRecommendation sets the recommendation on the check
type DocumentTextDataCheck ¶
type DocumentTextDataCheck struct { Result DocumentTextDataCheckResult `json:"result"` // contains filtered or unexported fields }
DocumentTextDataCheck represents a document text data check
type DocumentTextDataCheckBuilder ¶
type DocumentTextDataCheckBuilder struct {
// contains filtered or unexported fields
}
DocumentTextDataCheckBuilder builds a DocumentTextDataCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } docFilter, err := filter.NewDocumentFilterBuilder().Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } check, err := NewDocumentTextDataCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). WithDocumentFilter(docFilter). WithDocumentField("some-key", "some-value"). WithDocumentField("some-other-key", map[string]string{ "some-nested-key": "some-nested-value", }). 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: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]},"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}},"document_filter":{"document_types":[],"country_codes":[]}}
Example (Minimal) ¶
check, err := NewDocumentTextDataCheckBuilder().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: {"result":{"report":{}}}
func NewDocumentTextDataCheckBuilder ¶
func NewDocumentTextDataCheckBuilder() *DocumentTextDataCheckBuilder
NewDocumentTextDataCheckBuilder builds a new DocumentTextDataCheckResult
func (*DocumentTextDataCheckBuilder) Build ¶
func (b *DocumentTextDataCheckBuilder) Build() (*DocumentTextDataCheck, error)
Build creates a new DocumentTextDataCheck
func (*DocumentTextDataCheckBuilder) WithBreakdown ¶
func (b *DocumentTextDataCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *DocumentTextDataCheckBuilder
WithBreakdown adds a breakdown item to the check
func (*DocumentTextDataCheckBuilder) WithDocumentField ¶
func (b *DocumentTextDataCheckBuilder) WithDocumentField(key string, value interface{}) *DocumentTextDataCheckBuilder
WithDocumentField adds a document field to the text data check
func (*DocumentTextDataCheckBuilder) WithDocumentFields ¶
func (b *DocumentTextDataCheckBuilder) WithDocumentFields(documentFields map[string]interface{}) *DocumentTextDataCheckBuilder
WithDocumentFields sets document fields
Example ¶
check, err := NewDocumentTextDataCheckBuilder(). WithDocumentFields(map[string]interface{}{ "some-key": "some-value", "some-other-key": map[string]string{ "some-nested-key": "some-nested-value", }, }). 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: {"result":{"report":{},"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}}}
func (*DocumentTextDataCheckBuilder) WithDocumentFilter ¶
func (b *DocumentTextDataCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *DocumentTextDataCheckBuilder
WithDocumentFilter adds a document filter to the check
func (*DocumentTextDataCheckBuilder) WithRecommendation ¶
func (b *DocumentTextDataCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *DocumentTextDataCheckBuilder
WithRecommendation sets the recommendation on the check
type DocumentTextDataCheckResult ¶
type DocumentTextDataCheckResult struct { DocumentFields map[string]interface{} `json:"document_fields,omitempty"` // contains filtered or unexported fields }
DocumentTextDataCheckResult represent a document text data check result
type IDDocumentComparisonCheck ¶ added in v3.2.0
type IDDocumentComparisonCheck struct { SecondaryDocumentFilter *filter.DocumentFilter `json:"secondary_document_filter,omitempty"` // contains filtered or unexported fields }
IDDocumentComparisonCheck Represents a document authenticity check
type IDDocumentComparisonCheckBuilder ¶ added in v3.2.0
type IDDocumentComparisonCheckBuilder struct {
// contains filtered or unexported fields
}
IDDocumentComparisonCheckBuilder builds a IDDocumentComparisonCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). WithDetail("some_name", "some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } docFilter, err := filter.NewDocumentFilterBuilder(). WithCountryCode("AUS"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } idDocumentComparisonCheck, err := NewIDDocumentComparisonCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). WithSecondaryDocumentFilter(docFilter). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } data, err := json.Marshal(idDocumentComparisonCheck) if err != nil { fmt.Printf("error: %s", err.Error()) return } fmt.Println(string(data))
Output: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[{"name":"some_name","value":"some_value"}]}]}},"secondary_document_filter":{"document_types":[],"country_codes":["AUS"]}}
Example (Minimal) ¶
idDocumentComparisonCheck, err := NewIDDocumentComparisonCheckBuilder().Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } data, err := json.Marshal(idDocumentComparisonCheck) if err != nil { fmt.Printf("error: %s", err.Error()) return } fmt.Println(string(data))
Output: {"result":{"report":{}}}
func NewIDDocumentComparisonCheckBuilder ¶ added in v3.2.0
func NewIDDocumentComparisonCheckBuilder() *IDDocumentComparisonCheckBuilder
NewIDDocumentComparisonCheckBuilder creates a new IDDocumentComparisonCheckBuilder
func (*IDDocumentComparisonCheckBuilder) Build ¶ added in v3.2.0
func (b *IDDocumentComparisonCheckBuilder) Build() (*IDDocumentComparisonCheck, error)
Build creates a new IDDocumentComparisonCheck
func (*IDDocumentComparisonCheckBuilder) WithBreakdown ¶ added in v3.2.0
func (b *IDDocumentComparisonCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *IDDocumentComparisonCheckBuilder
WithBreakdown adds a breakdown item to the check
func (*IDDocumentComparisonCheckBuilder) WithRecommendation ¶ added in v3.2.0
func (b *IDDocumentComparisonCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *IDDocumentComparisonCheckBuilder
WithRecommendation sets the recommendation on the check
func (*IDDocumentComparisonCheckBuilder) WithSecondaryDocumentFilter ¶ added in v3.2.0
func (b *IDDocumentComparisonCheckBuilder) WithSecondaryDocumentFilter(filter *filter.DocumentFilter) *IDDocumentComparisonCheckBuilder
WithSecondaryDocumentFilter adds a secondary document filter to the check
type LivenessCheck ¶
type LivenessCheck struct { LivenessType string `json:"liveness_type"` // contains filtered or unexported fields }
LivenessCheck represents a liveness check
type StaticLivenessCheckBuilder ¶ added in v3.9.0
type StaticLivenessCheckBuilder struct {
// contains filtered or unexported fields
}
StaticLivenessCheckBuilder builds a Static LivenessCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } check, err := NewStaticLivenessCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). 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: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}},"liveness_type":"STATIC"}
func NewStaticLivenessCheckBuilder ¶ added in v3.9.0
func NewStaticLivenessCheckBuilder() *StaticLivenessCheckBuilder
NewStaticLivenessCheckBuilder creates a new StaticLivenessCheckBuilder
func (*StaticLivenessCheckBuilder) Build ¶ added in v3.9.0
func (b *StaticLivenessCheckBuilder) Build() (*LivenessCheck, error)
Build creates a new LivenessCheck
func (*StaticLivenessCheckBuilder) WithBreakdown ¶ added in v3.9.0
func (b *StaticLivenessCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *StaticLivenessCheckBuilder
WithBreakdown adds a breakdown item to the check
func (*StaticLivenessCheckBuilder) WithRecommendation ¶ added in v3.9.0
func (b *StaticLivenessCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *StaticLivenessCheckBuilder
WithRecommendation sets the recommendation on the check
type SupplementaryDocumentTextDataCheck ¶ added in v3.3.0
type SupplementaryDocumentTextDataCheck struct { Result SupplementaryDocumentTextDataCheckResult `json:"result"` // contains filtered or unexported fields }
SupplementaryDocumentTextDataCheck represents a supplementary document text data check
type SupplementaryDocumentTextDataCheckBuilder ¶ added in v3.3.0
type SupplementaryDocumentTextDataCheckBuilder struct {
// contains filtered or unexported fields
}
SupplementaryDocumentTextDataCheckBuilder builds a SupplementaryDocumentTextDataCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } docFilter, err := filter.NewDocumentFilterBuilder().Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } check, err := NewSupplementaryDocumentTextDataCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). WithDocumentFilter(docFilter). WithDocumentField("some-key", "some-value"). WithDocumentField("some-other-key", map[string]string{ "some-nested-key": "some-nested-value", }). 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: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]},"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}},"document_filter":{"document_types":[],"country_codes":[]}}
Example (Minimal) ¶
check, err := NewSupplementaryDocumentTextDataCheckBuilder().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: {"result":{"report":{}}}
func NewSupplementaryDocumentTextDataCheckBuilder ¶ added in v3.3.0
func NewSupplementaryDocumentTextDataCheckBuilder() *SupplementaryDocumentTextDataCheckBuilder
NewSupplementaryDocumentTextDataCheckBuilder builds a new SupplementaryDocumentTextDataCheckResult
func (*SupplementaryDocumentTextDataCheckBuilder) Build ¶ added in v3.3.0
func (b *SupplementaryDocumentTextDataCheckBuilder) Build() (*SupplementaryDocumentTextDataCheck, error)
Build creates a new SupplementaryDocumentTextDataCheck
func (*SupplementaryDocumentTextDataCheckBuilder) WithBreakdown ¶ added in v3.3.0
func (b *SupplementaryDocumentTextDataCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *SupplementaryDocumentTextDataCheckBuilder
WithBreakdown adds a breakdown item to the check
func (*SupplementaryDocumentTextDataCheckBuilder) WithDocumentField ¶ added in v3.3.0
func (b *SupplementaryDocumentTextDataCheckBuilder) WithDocumentField(key string, value interface{}) *SupplementaryDocumentTextDataCheckBuilder
WithDocumentField adds a document field to the text data check
func (*SupplementaryDocumentTextDataCheckBuilder) WithDocumentFields ¶ added in v3.3.0
func (b *SupplementaryDocumentTextDataCheckBuilder) WithDocumentFields(documentFields map[string]interface{}) *SupplementaryDocumentTextDataCheckBuilder
WithDocumentFields sets document fields
Example ¶
check, err := NewSupplementaryDocumentTextDataCheckBuilder(). WithDocumentFields(map[string]interface{}{ "some-key": "some-value", "some-other-key": map[string]string{ "some-nested-key": "some-nested-value", }, }). 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: {"result":{"report":{},"document_fields":{"some-key":"some-value","some-other-key":{"some-nested-key":"some-nested-value"}}}}
func (*SupplementaryDocumentTextDataCheckBuilder) WithDocumentFilter ¶ added in v3.3.0
func (b *SupplementaryDocumentTextDataCheckBuilder) WithDocumentFilter(filter *filter.DocumentFilter) *SupplementaryDocumentTextDataCheckBuilder
WithDocumentFilter adds a document filter to the check
func (*SupplementaryDocumentTextDataCheckBuilder) WithRecommendation ¶ added in v3.3.0
func (b *SupplementaryDocumentTextDataCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *SupplementaryDocumentTextDataCheckBuilder
WithRecommendation sets the recommendation on the check
type SupplementaryDocumentTextDataCheckResult ¶ added in v3.3.0
type SupplementaryDocumentTextDataCheckResult struct { DocumentFields map[string]interface{} `json:"document_fields,omitempty"` // contains filtered or unexported fields }
SupplementaryDocumentTextDataCheckResult represents a document text data check result
type ThirdPartyIdentityCheck ¶ added in v3.4.0
type ThirdPartyIdentityCheck struct {
// contains filtered or unexported fields
}
ThirdPartyIdentityCheck defines a sandbox check with a third party credit reporting agency
type ThirdPartyIdentityCheckBuilder ¶ added in v3.4.0
type ThirdPartyIdentityCheckBuilder struct {
// contains filtered or unexported fields
}
ThirdPartyIdentityCheckBuilder builds a ThirdPartyIdentityCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } check, err := NewThirdPartyIdentityCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). 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: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}}}
func NewThirdPartyIdentityCheckBuilder ¶ added in v3.4.0
func NewThirdPartyIdentityCheckBuilder() *ThirdPartyIdentityCheckBuilder
NewThirdPartyIdentityCheckBuilder creates a new ThirdPartyIdentityCheckBuilder
func (*ThirdPartyIdentityCheckBuilder) Build ¶ added in v3.4.0
func (b *ThirdPartyIdentityCheckBuilder) Build() (*ThirdPartyIdentityCheck, error)
Build creates a new ThirdPartyIdentityCheck
func (*ThirdPartyIdentityCheckBuilder) WithBreakdown ¶ added in v3.4.0
func (b *ThirdPartyIdentityCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *ThirdPartyIdentityCheckBuilder
func (*ThirdPartyIdentityCheckBuilder) WithRecommendation ¶ added in v3.4.0
func (b *ThirdPartyIdentityCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *ThirdPartyIdentityCheckBuilder
type ZoomLivenessCheckBuilder ¶
type ZoomLivenessCheckBuilder struct {
// contains filtered or unexported fields
}
ZoomLivenessCheckBuilder builds a "ZOOM" LivenessCheck
Example ¶
breakdown, err := report.NewBreakdownBuilder(). WithResult("some_result"). WithSubCheck("some_check"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } recommendation, err := report.NewRecommendationBuilder(). WithValue("some_value"). Build() if err != nil { fmt.Printf("error: %s", err.Error()) return } check, err := NewZoomLivenessCheckBuilder(). WithBreakdown(breakdown). WithRecommendation(recommendation). 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: {"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}},"liveness_type":"ZOOM"}
func NewZoomLivenessCheckBuilder ¶
func NewZoomLivenessCheckBuilder() *ZoomLivenessCheckBuilder
NewZoomLivenessCheckBuilder creates a new ZoomLivenessCheckBuilder
func (*ZoomLivenessCheckBuilder) Build ¶
func (b *ZoomLivenessCheckBuilder) Build() (*LivenessCheck, error)
Build creates a new LivenessCheck
func (*ZoomLivenessCheckBuilder) WithBreakdown ¶
func (b *ZoomLivenessCheckBuilder) WithBreakdown(breakdown *report.Breakdown) *ZoomLivenessCheckBuilder
WithBreakdown adds a breakdown item to the check
func (*ZoomLivenessCheckBuilder) WithRecommendation ¶
func (b *ZoomLivenessCheckBuilder) WithRecommendation(recommendation *report.Recommendation) *ZoomLivenessCheckBuilder
WithRecommendation sets the recommendation on the check