request

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: 3 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckReports 

type CheckReports struct {
	DocumentAuthenticityChecks          []*check.DocumentAuthenticityCheck          `json:"ID_DOCUMENT_AUTHENTICITY"`
	DocumentTextDataChecks              []*check.DocumentTextDataCheck              `json:"ID_DOCUMENT_TEXT_DATA_CHECK"`
	DocumentFaceMatchChecks             []*check.DocumentFaceMatchCheck             `json:"ID_DOCUMENT_FACE_MATCH"`
	LivenessChecks                      []*check.LivenessCheck                      `json:"LIVENESS"`
	IDDocumentComparisonChecks          []*check.IDDocumentComparisonCheck          `json:"ID_DOCUMENT_COMPARISON"`
	SupplementaryDocumentTextDataChecks []*check.SupplementaryDocumentTextDataCheck `json:"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK"`
	AsyncReportDelay                    uint32                                      `json:"async_report_delay,omitempty"`
	ThirdPartyIdentityCheck             *check.ThirdPartyIdentityCheck              `json:"THIRD_PARTY_IDENTITY,omitempty"`
}

CheckReports represents check reports

type CheckReportsBuilder 

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

CheckReportsBuilder builds CheckReports

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
}

authenticityCheck, err := check.NewDocumentAuthenticityCheckBuilder().
	WithBreakdown(breakdown).
	WithRecommendation(recommendation).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

faceMatchCheck, err := check.NewDocumentFaceMatchCheckBuilder().
	WithBreakdown(breakdown).
	WithRecommendation(recommendation).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

textDataCheck, err := check.NewDocumentTextDataCheckBuilder().
	WithBreakdown(breakdown).
	WithRecommendation(recommendation).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

supplementaryDocumentTextDataCheck, err := check.NewSupplementaryDocumentTextDataCheckBuilder().
	WithBreakdown(breakdown).
	WithRecommendation(recommendation).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

thirdPartyCheck, err := check.NewThirdPartyIdentityCheckBuilder().
	WithBreakdown(breakdown).
	WithRecommendation(recommendation).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

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

documentFiler, err := filter.NewDocumentFilterBuilder().Build()
idDocumentComparisonCheck, err := check.NewIDDocumentComparisonCheckBuilder().
	WithSecondaryDocumentFilter(documentFiler).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

checkReports, err := NewCheckReportsBuilder().
	WithDocumentAuthenticityCheck(authenticityCheck).
	WithDocumentFaceMatchCheck(faceMatchCheck).
	WithDocumentTextDataCheck(textDataCheck).
	WithLivenessCheck(zoomLivenessCheck).
	WithIDDocumentComparisonCheck(idDocumentComparisonCheck).
	WithSupplementaryDocumentTextDataCheck(supplementaryDocumentTextDataCheck).
	WithThirdPartyIdentityCheck(thirdPartyCheck).
	WithAsyncReportDelay(10).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

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

fmt.Println(string(data))

Output:

{"ID_DOCUMENT_AUTHENTICITY":[{"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}}}],"ID_DOCUMENT_TEXT_DATA_CHECK":[{"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}}}],"ID_DOCUMENT_FACE_MATCH":[{"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}}}],"LIVENESS":[{"result":{"report":{}},"liveness_type":"ZOOM"}],"ID_DOCUMENT_COMPARISON":[{"result":{"report":{}},"secondary_document_filter":{"document_types":[],"country_codes":[]}}],"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK":[{"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}}}],"async_report_delay":10,"THIRD_PARTY_IDENTITY":{"result":{"report":{"recommendation":{"value":"some_value"},"breakdown":[{"sub_check":"some_check","result":"some_result","details":[]}]}}}}
Example (Minimal) 
checkReports, err := NewCheckReportsBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

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

fmt.Println(string(data))

Output:

{"ID_DOCUMENT_AUTHENTICITY":[],"ID_DOCUMENT_TEXT_DATA_CHECK":[],"ID_DOCUMENT_FACE_MATCH":[],"LIVENESS":[],"ID_DOCUMENT_COMPARISON":[],"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK":[]}

func NewCheckReportsBuilder 

func NewCheckReportsBuilder() *CheckReportsBuilder

NewCheckReportsBuilder creates a new CheckReportsBuilder

func (*CheckReportsBuilder) Build 

func (b *CheckReportsBuilder) Build() (CheckReports, error)

Build creates CheckReports

func (*CheckReportsBuilder) WithAsyncReportDelay 

func (b *CheckReportsBuilder) WithAsyncReportDelay(asyncReportDelay uint32) *CheckReportsBuilder

WithAsyncReportDelay sets the async report delay

func (*CheckReportsBuilder) WithDocumentAuthenticityCheck 

func (b *CheckReportsBuilder) WithDocumentAuthenticityCheck(documentAuthenticityCheck *check.DocumentAuthenticityCheck) *CheckReportsBuilder

WithDocumentAuthenticityCheck adds a document authenticity check

func (*CheckReportsBuilder) WithDocumentFaceMatchCheck 

func (b *CheckReportsBuilder) WithDocumentFaceMatchCheck(documentFaceMatchCheck *check.DocumentFaceMatchCheck) *CheckReportsBuilder

WithDocumentFaceMatchCheck adds a document face match check

func (*CheckReportsBuilder) WithDocumentTextDataCheck 

func (b *CheckReportsBuilder) WithDocumentTextDataCheck(documentTextDataCheck *check.DocumentTextDataCheck) *CheckReportsBuilder

WithDocumentTextDataCheck adds a document text data check

func (*CheckReportsBuilder) WithIDDocumentComparisonCheck added in v3.2.0 

func (b *CheckReportsBuilder) WithIDDocumentComparisonCheck(idDocumentComparisonCheck *check.IDDocumentComparisonCheck) *CheckReportsBuilder

WithIDDocumentComparisonCheck adds an identity document comparison check

func (*CheckReportsBuilder) WithLivenessCheck 

func (b *CheckReportsBuilder) WithLivenessCheck(livenessCheck *check.LivenessCheck) *CheckReportsBuilder

WithLivenessCheck adds a liveness check

func (*CheckReportsBuilder) WithSupplementaryDocumentTextDataCheck added in v3.3.0 

func (b *CheckReportsBuilder) WithSupplementaryDocumentTextDataCheck(supplementaryDocumentTextDataCheck *check.SupplementaryDocumentTextDataCheck) *CheckReportsBuilder

WithDocumentTextDataCheck adds a supplementary document text data check

func (*CheckReportsBuilder) WithThirdPartyIdentityCheck added in v3.4.0 

func (b *CheckReportsBuilder) WithThirdPartyIdentityCheck(thirdPartyIdentityCheck *check.ThirdPartyIdentityCheck) *CheckReportsBuilder

type ResponseConfig 

type ResponseConfig struct {
	TaskResults  *TaskResults  `json:"task_results,omitempty"`
	CheckReports *CheckReports `json:"check_reports"`
}

ResponseConfig represents the response config

type ResponseConfigBuilder 

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

ResponseConfigBuilder builds ResponseConfig

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

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

responseConfig, err := NewResponseConfigBuilder().
	WithTaskResults(taskResults).
	WithCheckReports(checkReports).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

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

fmt.Println(string(data))

Output:

{"task_results":{"ID_DOCUMENT_TEXT_DATA_EXTRACTION":[],"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION":[]},"check_reports":{"ID_DOCUMENT_AUTHENTICITY":[],"ID_DOCUMENT_TEXT_DATA_CHECK":[],"ID_DOCUMENT_FACE_MATCH":[],"LIVENESS":[],"ID_DOCUMENT_COMPARISON":[],"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK":[]}}
Example (Minimal) 
checkReports, err := NewCheckReportsBuilder().Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

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

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

fmt.Println(string(data))

Output:

{"check_reports":{"ID_DOCUMENT_AUTHENTICITY":[],"ID_DOCUMENT_TEXT_DATA_CHECK":[],"ID_DOCUMENT_FACE_MATCH":[],"LIVENESS":[],"ID_DOCUMENT_COMPARISON":[],"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK":[]}}

func NewResponseConfigBuilder 

func NewResponseConfigBuilder() *ResponseConfigBuilder

NewResponseConfigBuilder creates a new ResponseConfigBuilder

func (*ResponseConfigBuilder) Build 

func (b *ResponseConfigBuilder) Build() (*ResponseConfig, error)

Build creates ResponseConfig

func (*ResponseConfigBuilder) WithCheckReports 

func (b *ResponseConfigBuilder) WithCheckReports(checkReports CheckReports) *ResponseConfigBuilder

WithCheckReports adds check reports to the response configuration

func (*ResponseConfigBuilder) WithTaskResults 

func (b *ResponseConfigBuilder) WithTaskResults(taskResults TaskResults) *ResponseConfigBuilder

WithTaskResults adds task results to the response configuration

type TaskResults 

type TaskResults struct {
	DocumentTextDataExtractionTasks              []*task.DocumentTextDataExtractionTask              `json:"ID_DOCUMENT_TEXT_DATA_EXTRACTION"`
	SupplementaryDocumentTextDataExtractionTasks []*task.SupplementaryDocumentTextDataExtractionTask `json:"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION"`
}

TaskResults represents task results

type TaskResultsBuilder 

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

TaskResultsBuilder builds TaskResults

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

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

taskResults, err := NewTaskResultsBuilder().
	WithDocumentTextDataExtractionTask(textDataExtractionTask).
	WithSupplementaryDocumentTextDataExtractionTask(supplementaryTextDataExtractionTask).
	Build()
if err != nil {
	fmt.Printf("error: %s", err.Error())
	return
}

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

fmt.Println(string(data))

Output:

{"ID_DOCUMENT_TEXT_DATA_EXTRACTION":[{"result":{}}],"SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION":[{"result":{}}]}

func NewTaskResultsBuilder 

func NewTaskResultsBuilder() *TaskResultsBuilder

NewTaskResultsBuilder creates a new TaskResultsBuilder

func (*TaskResultsBuilder) Build 

func (b *TaskResultsBuilder) Build() (TaskResults, error)

Build creates TaskResults

func (*TaskResultsBuilder) WithDocumentTextDataExtractionTask 

func (b *TaskResultsBuilder) WithDocumentTextDataExtractionTask(documentTextDataExtractionTask *task.DocumentTextDataExtractionTask) *TaskResultsBuilder

WithDocumentTextDataExtractionTask adds a supplementary document text data extraction task

func (*TaskResultsBuilder) WithSupplementaryDocumentTextDataExtractionTask added in v3.3.0 

func (b *TaskResultsBuilder) WithSupplementaryDocumentTextDataExtractionTask(supplementaryTextDataExtractionTask *task.SupplementaryDocumentTextDataExtractionTask) *TaskResultsBuilder

WithSupplementaryDocumentTextDataExtractionTask adds a supplementary document text data extraction task

Source Files

View all Source files

Directories

Path Synopsis
report

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.