connect

package
v1.14.0 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Connect_CreateSession_FullMethodName      = "/services.connect.v1.Connect/CreateSession"
	Connect_CancelSession_FullMethodName      = "/services.connect.v1.Connect/CancelSession"
	Connect_GetSession_FullMethodName         = "/services.connect.v1.Connect/GetSession"
	Connect_ListSessions_FullMethodName       = "/services.connect.v1.Connect/ListSessions"
	Connect_HasValidCredential_FullMethodName = "/services.connect.v1.Connect/HasValidCredential"
)

Variables

View Source
var (
	VerificationType_name = map[int32]string{
		0: "GOVERNMENT_ID",
	}
	VerificationType_value = map[string]int32{
		"GOVERNMENT_ID": 0,
	}
)

Enum value maps for VerificationType.

View Source
var (
	IDVSessionState_name = map[int32]string{
		0: "IDV_CREATED",
		1: "IDV_INITIATED",
		2: "IDV_AUTHENTICATING",
		3: "IDV_IN_PROGRESS",
		4: "IDV_SUCCESS",
		5: "IDV_FAILED",
	}
	IDVSessionState_value = map[string]int32{
		"IDV_CREATED":        0,
		"IDV_INITIATED":      1,
		"IDV_AUTHENTICATING": 2,
		"IDV_IN_PROGRESS":    3,
		"IDV_SUCCESS":        4,
		"IDV_FAILED":         5,
	}
)

Enum value maps for IDVSessionState.

View Source
var (
	VerificationState_name = map[int32]string{
		0: "VERIFICATION_PENDING",
		1: "VERIFICATION_PENDING_REUSE",
		2: "VERIFICATION_STARTED",
		3: "VERIFICATION_SUCCESS",
		4: "VERIFICATION_FAILED",
	}
	VerificationState_value = map[string]int32{
		"VERIFICATION_PENDING":       0,
		"VERIFICATION_PENDING_REUSE": 1,
		"VERIFICATION_STARTED":       2,
		"VERIFICATION_SUCCESS":       3,
		"VERIFICATION_FAILED":        4,
	}
)

Enum value maps for VerificationState.

View Source
var (
	SessionFailCode_name = map[int32]string{
		0: "SESSION_FAIL_NONE",
		1: "SESSION_FAIL_INTERNAL",
		2: "SESSION_FAIL_VERIFICATION_FAILED",
		3: "SESSION_FAIL_AUTHENTICATION",
		4: "SESSION_FAIL_EXPIRED",
		5: "SESSION_FAIL_USER_CANCELED",
		6: "SESSION_FAIL_RP_CANCELED",
	}
	SessionFailCode_value = map[string]int32{
		"SESSION_FAIL_NONE":                0,
		"SESSION_FAIL_INTERNAL":            1,
		"SESSION_FAIL_VERIFICATION_FAILED": 2,
		"SESSION_FAIL_AUTHENTICATION":      3,
		"SESSION_FAIL_EXPIRED":             4,
		"SESSION_FAIL_USER_CANCELED":       5,
		"SESSION_FAIL_RP_CANCELED":         6,
	}
)

Enum value maps for SessionFailCode.

View Source
var (
	VerificationFailCode_name = map[int32]string{
		0: "VERIFICATION_FAIL_NONE",
		1: "VERIFICATION_FAIL_INTERNAL",
		2: "VERIFICATION_FAIL_INVALID_IMAGE",
		3: "VERIFICATION_FAIL_INAUTHENTIC",
		4: "VERIFICATION_FAIL_UNSUPPORTED_DOCUMENT",
	}
	VerificationFailCode_value = map[string]int32{
		"VERIFICATION_FAIL_NONE":                 0,
		"VERIFICATION_FAIL_INTERNAL":             1,
		"VERIFICATION_FAIL_INVALID_IMAGE":        2,
		"VERIFICATION_FAIL_INAUTHENTIC":          3,
		"VERIFICATION_FAIL_UNSUPPORTED_DOCUMENT": 4,
	}
)

Enum value maps for VerificationFailCode.

View Source
var (
	SessionOrdering_name = map[int32]string{
		0: "CREATED",
		1: "UPDATED",
		2: "STATE",
	}
	SessionOrdering_value = map[string]int32{
		"CREATED": 0,
		"UPDATED": 1,
		"STATE":   2,
	}
)

Enum value maps for SessionOrdering.

View Source
var Connect_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "services.connect.v1.Connect",
	HandlerType: (*ConnectServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateSession",
			Handler:    _Connect_CreateSession_Handler,
		},
		{
			MethodName: "CancelSession",
			Handler:    _Connect_CancelSession_Handler,
		},
		{
			MethodName: "GetSession",
			Handler:    _Connect_GetSession_Handler,
		},
		{
			MethodName: "ListSessions",
			Handler:    _Connect_ListSessions_Handler,
		},
		{
			MethodName: "HasValidCredential",
			Handler:    _Connect_HasValidCredential_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "services/connect/v1/connect.proto",
}

Connect_ServiceDesc is the grpc.ServiceDesc for Connect service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_services_connect_v1_connect_proto protoreflect.FileDescriptor

Functions

func RegisterConnectServer

func RegisterConnectServer(s grpc.ServiceRegistrar, srv ConnectServer)

Types

type CancelSessionRequest

type CancelSessionRequest struct {

	// The ID of the IDVSession to cancel
	IdvSessionId string `protobuf:"bytes,1,opt,name=idv_session_id,json=idvSessionId,proto3" json:"idv_session_id,omitempty"`
	// contains filtered or unexported fields
}

Request to cancel an Identity Verification Session

func (*CancelSessionRequest) Descriptor deprecated

func (*CancelSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CancelSessionRequest.ProtoReflect.Descriptor instead.

func (*CancelSessionRequest) GetIdvSessionId

func (x *CancelSessionRequest) GetIdvSessionId() string

func (*CancelSessionRequest) ProtoMessage

func (*CancelSessionRequest) ProtoMessage()

func (*CancelSessionRequest) ProtoReflect

func (x *CancelSessionRequest) ProtoReflect() protoreflect.Message

func (*CancelSessionRequest) Reset

func (x *CancelSessionRequest) Reset()

func (*CancelSessionRequest) String

func (x *CancelSessionRequest) String() string

type CancelSessionResponse

type CancelSessionResponse struct {

	// The IDVSession in its current state after cancellation
	Session *IDVSession `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

Response to `CancelIDVSessionRequest`

func (*CancelSessionResponse) Descriptor deprecated

func (*CancelSessionResponse) Descriptor() ([]byte, []int)

Deprecated: Use CancelSessionResponse.ProtoReflect.Descriptor instead.

func (*CancelSessionResponse) GetSession

func (x *CancelSessionResponse) GetSession() *IDVSession

func (*CancelSessionResponse) ProtoMessage

func (*CancelSessionResponse) ProtoMessage()

func (*CancelSessionResponse) ProtoReflect

func (x *CancelSessionResponse) ProtoReflect() protoreflect.Message

func (*CancelSessionResponse) Reset

func (x *CancelSessionResponse) Reset()

func (*CancelSessionResponse) String

func (x *CancelSessionResponse) String() string

type ConnectClient

type ConnectClient interface {
	// Create an IDVSession
	CreateSession(ctx context.Context, in *CreateSessionRequest, opts ...grpc.CallOption) (*CreateSessionResponse, error)
	// Cancel an IDVSession
	CancelSession(ctx context.Context, in *CancelSessionRequest, opts ...grpc.CallOption) (*CancelSessionResponse, error)
	// Get an IDVSession
	GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*GetSessionResponse, error)
	// List IDVSessions created by the calling wallet
	ListSessions(ctx context.Context, in *ListSessionsRequest, opts ...grpc.CallOption) (*ListSessionsResponse, error)
	// Checks if the identity provided in the request has a wallet containing a valid reusable credential
	HasValidCredential(ctx context.Context, in *HasValidCredentialRequest, opts ...grpc.CallOption) (*HasValidCredentialResponse, error)
}

ConnectClient is the client API for Connect service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewConnectClient

func NewConnectClient(cc grpc.ClientConnInterface) ConnectClient

type ConnectServer

type ConnectServer interface {
	// Create an IDVSession
	CreateSession(context.Context, *CreateSessionRequest) (*CreateSessionResponse, error)
	// Cancel an IDVSession
	CancelSession(context.Context, *CancelSessionRequest) (*CancelSessionResponse, error)
	// Get an IDVSession
	GetSession(context.Context, *GetSessionRequest) (*GetSessionResponse, error)
	// List IDVSessions created by the calling wallet
	ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
	// Checks if the identity provided in the request has a wallet containing a valid reusable credential
	HasValidCredential(context.Context, *HasValidCredentialRequest) (*HasValidCredentialResponse, error)
	// contains filtered or unexported methods
}

ConnectServer is the server API for Connect service. All implementations must embed UnimplementedConnectServer for forward compatibility

type CreateSessionRequest

type CreateSessionRequest struct {

	// Array of verifications to perform
	Verifications []*RequestedVerification `protobuf:"bytes,1,rep,name=verifications,proto3" json:"verifications,omitempty"`
	// Debugging information used to help diagnose issues
	DebugInformation map[string]string `` /* 197-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request to create an Identity Verification Session

func (*CreateSessionRequest) Descriptor deprecated

func (*CreateSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateSessionRequest.ProtoReflect.Descriptor instead.

func (*CreateSessionRequest) GetDebugInformation added in v1.14.0

func (x *CreateSessionRequest) GetDebugInformation() map[string]string

func (*CreateSessionRequest) GetVerifications

func (x *CreateSessionRequest) GetVerifications() []*RequestedVerification

func (*CreateSessionRequest) ProtoMessage

func (*CreateSessionRequest) ProtoMessage()

func (*CreateSessionRequest) ProtoReflect

func (x *CreateSessionRequest) ProtoReflect() protoreflect.Message

func (*CreateSessionRequest) Reset

func (x *CreateSessionRequest) Reset()

func (*CreateSessionRequest) String

func (x *CreateSessionRequest) String() string

type CreateSessionResponse

type CreateSessionResponse struct {

	// The created IDVSession
	Session *IDVSession `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

Response to `CreateIDVSessionRequest`

func (*CreateSessionResponse) Descriptor deprecated

func (*CreateSessionResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateSessionResponse.ProtoReflect.Descriptor instead.

func (*CreateSessionResponse) GetSession

func (x *CreateSessionResponse) GetSession() *IDVSession

func (*CreateSessionResponse) ProtoMessage

func (*CreateSessionResponse) ProtoMessage()

func (*CreateSessionResponse) ProtoReflect

func (x *CreateSessionResponse) ProtoReflect() protoreflect.Message

func (*CreateSessionResponse) Reset

func (x *CreateSessionResponse) Reset()

func (*CreateSessionResponse) String

func (x *CreateSessionResponse) String() string

type CredentialRequestData added in v1.14.0

type CredentialRequestData struct {

	// The type of verification for which the credential can be used
	Type VerificationType `protobuf:"varint,1,opt,name=type,proto3,enum=services.connect.v1.VerificationType" json:"type,omitempty"` // Name of the IDV issuer
	// contains filtered or unexported fields
}

func (*CredentialRequestData) Descriptor deprecated added in v1.14.0

func (*CredentialRequestData) Descriptor() ([]byte, []int)

Deprecated: Use CredentialRequestData.ProtoReflect.Descriptor instead.

func (*CredentialRequestData) GetType added in v1.14.0

func (*CredentialRequestData) ProtoMessage added in v1.14.0

func (*CredentialRequestData) ProtoMessage()

func (*CredentialRequestData) ProtoReflect added in v1.14.0

func (x *CredentialRequestData) ProtoReflect() protoreflect.Message

func (*CredentialRequestData) Reset added in v1.14.0

func (x *CredentialRequestData) Reset()

func (*CredentialRequestData) String added in v1.14.0

func (x *CredentialRequestData) String() string

type GetSessionRequest

type GetSessionRequest struct {

	// The ID of the IDVSession to get
	IdvSessionId string `protobuf:"bytes,1,opt,name=idv_session_id,json=idvSessionId,proto3" json:"idv_session_id,omitempty"`
	// contains filtered or unexported fields
}

Request to get an IDVSession

func (*GetSessionRequest) Descriptor deprecated

func (*GetSessionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSessionRequest.ProtoReflect.Descriptor instead.

func (*GetSessionRequest) GetIdvSessionId

func (x *GetSessionRequest) GetIdvSessionId() string

func (*GetSessionRequest) ProtoMessage

func (*GetSessionRequest) ProtoMessage()

func (*GetSessionRequest) ProtoReflect

func (x *GetSessionRequest) ProtoReflect() protoreflect.Message

func (*GetSessionRequest) Reset

func (x *GetSessionRequest) Reset()

func (*GetSessionRequest) String

func (x *GetSessionRequest) String() string

type GetSessionResponse

type GetSessionResponse struct {

	// The IDVSession
	Session *IDVSession `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

Response to `GetIDVSessionRequest`

func (*GetSessionResponse) Descriptor deprecated

func (*GetSessionResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetSessionResponse.ProtoReflect.Descriptor instead.

func (*GetSessionResponse) GetSession

func (x *GetSessionResponse) GetSession() *IDVSession

func (*GetSessionResponse) ProtoMessage

func (*GetSessionResponse) ProtoMessage()

func (*GetSessionResponse) ProtoReflect

func (x *GetSessionResponse) ProtoReflect() protoreflect.Message

func (*GetSessionResponse) Reset

func (x *GetSessionResponse) Reset()

func (*GetSessionResponse) String

func (x *GetSessionResponse) String() string

type GovernmentIDFields added in v1.13.0

type GovernmentIDFields struct {

	// ID number of the underlying identity document
	IdNumber bool `protobuf:"varint,1,opt,name=id_number,json=idNumber,proto3" json:"id_number,omitempty"`
	// Given ("first") name of the document holder
	GivenName bool `protobuf:"varint,2,opt,name=given_name,json=givenName,proto3" json:"given_name,omitempty"`
	// Family ("last") name of the document holder
	FamilyName bool `protobuf:"varint,3,opt,name=family_name,json=familyName,proto3" json:"family_name,omitempty"`
	// Full address of the document holder
	Address bool `protobuf:"varint,4,opt,name=address,proto3" json:"address,omitempty"`
	// Date of birth of the document holder
	DateOfBirth bool `protobuf:"varint,5,opt,name=date_of_birth,json=dateOfBirth,proto3" json:"date_of_birth,omitempty"`
	// ISO3 country code of the document
	Country bool `protobuf:"varint,6,opt,name=country,proto3" json:"country,omitempty"`
	// Issuance date of the document
	IssueDate bool `protobuf:"varint,7,opt,name=issue_date,json=issueDate,proto3" json:"issue_date,omitempty"`
	// Expiration date date of the document
	ExpirationDate bool `protobuf:"varint,8,opt,name=expiration_date,json=expirationDate,proto3" json:"expiration_date,omitempty"`
	// contains filtered or unexported fields
}

Selection of fields to retrieve from a Government ID. All fields default to `false` unless explicitly set to `true`.

func (*GovernmentIDFields) Descriptor deprecated added in v1.13.0

func (*GovernmentIDFields) Descriptor() ([]byte, []int)

Deprecated: Use GovernmentIDFields.ProtoReflect.Descriptor instead.

func (*GovernmentIDFields) GetAddress added in v1.13.0

func (x *GovernmentIDFields) GetAddress() bool

func (*GovernmentIDFields) GetCountry added in v1.13.0

func (x *GovernmentIDFields) GetCountry() bool

func (*GovernmentIDFields) GetDateOfBirth added in v1.13.0

func (x *GovernmentIDFields) GetDateOfBirth() bool

func (*GovernmentIDFields) GetExpirationDate added in v1.13.0

func (x *GovernmentIDFields) GetExpirationDate() bool

func (*GovernmentIDFields) GetFamilyName added in v1.13.0

func (x *GovernmentIDFields) GetFamilyName() bool

func (*GovernmentIDFields) GetGivenName added in v1.13.0

func (x *GovernmentIDFields) GetGivenName() bool

func (*GovernmentIDFields) GetIdNumber added in v1.13.0

func (x *GovernmentIDFields) GetIdNumber() bool

func (*GovernmentIDFields) GetIssueDate added in v1.13.0

func (x *GovernmentIDFields) GetIssueDate() bool

func (*GovernmentIDFields) ProtoMessage added in v1.13.0

func (*GovernmentIDFields) ProtoMessage()

func (*GovernmentIDFields) ProtoReflect added in v1.13.0

func (x *GovernmentIDFields) ProtoReflect() protoreflect.Message

func (*GovernmentIDFields) Reset added in v1.13.0

func (x *GovernmentIDFields) Reset()

func (*GovernmentIDFields) String added in v1.13.0

func (x *GovernmentIDFields) String() string

type GovernmentIDOptions added in v1.13.0

type GovernmentIDOptions struct {

	// The fields to retrieve from the Government ID.
	// If this object is not set, all fields will be retrieved.
	Fields *GovernmentIDFields `protobuf:"bytes,1,opt,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

Options for a Verification of type `GOVERNMENT_ID`

func (*GovernmentIDOptions) Descriptor deprecated added in v1.13.0

func (*GovernmentIDOptions) Descriptor() ([]byte, []int)

Deprecated: Use GovernmentIDOptions.ProtoReflect.Descriptor instead.

func (*GovernmentIDOptions) GetFields added in v1.13.0

func (x *GovernmentIDOptions) GetFields() *GovernmentIDFields

func (*GovernmentIDOptions) ProtoMessage added in v1.13.0

func (*GovernmentIDOptions) ProtoMessage()

func (*GovernmentIDOptions) ProtoReflect added in v1.13.0

func (x *GovernmentIDOptions) ProtoReflect() protoreflect.Message

func (*GovernmentIDOptions) Reset added in v1.13.0

func (x *GovernmentIDOptions) Reset()

func (*GovernmentIDOptions) String added in v1.13.0

func (x *GovernmentIDOptions) String() string

type HasValidCredentialRequest added in v1.14.0

type HasValidCredentialRequest struct {

	// The identity used to find a credential
	Identity *wallet.CreateWalletRequest_ExternalIdentity `protobuf:"bytes,1,opt,name=identity,proto3" json:"identity,omitempty"`
	// The criteria used to find a valid credential
	CredentialRequestData *CredentialRequestData `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request to preemptively check if an identity has a valid reusable credential

func (*HasValidCredentialRequest) Descriptor deprecated added in v1.14.0

func (*HasValidCredentialRequest) Descriptor() ([]byte, []int)

Deprecated: Use HasValidCredentialRequest.ProtoReflect.Descriptor instead.

func (*HasValidCredentialRequest) GetCredentialRequestData added in v1.14.0

func (x *HasValidCredentialRequest) GetCredentialRequestData() *CredentialRequestData

func (*HasValidCredentialRequest) GetIdentity added in v1.14.0

func (*HasValidCredentialRequest) ProtoMessage added in v1.14.0

func (*HasValidCredentialRequest) ProtoMessage()

func (*HasValidCredentialRequest) ProtoReflect added in v1.14.0

func (*HasValidCredentialRequest) Reset added in v1.14.0

func (x *HasValidCredentialRequest) Reset()

func (*HasValidCredentialRequest) String added in v1.14.0

func (x *HasValidCredentialRequest) String() string

type HasValidCredentialResponse added in v1.14.0

type HasValidCredentialResponse struct {

	// Whether the identity has a valid credential
	HasValidCredential bool `protobuf:"varint,1,opt,name=has_valid_credential,json=hasValidCredential,proto3" json:"has_valid_credential,omitempty"`
	// contains filtered or unexported fields
}

Response to `HasValidCredentialRequest`

func (*HasValidCredentialResponse) Descriptor deprecated added in v1.14.0

func (*HasValidCredentialResponse) Descriptor() ([]byte, []int)

Deprecated: Use HasValidCredentialResponse.ProtoReflect.Descriptor instead.

func (*HasValidCredentialResponse) GetHasValidCredential added in v1.14.0

func (x *HasValidCredentialResponse) GetHasValidCredential() bool

func (*HasValidCredentialResponse) ProtoMessage added in v1.14.0

func (*HasValidCredentialResponse) ProtoMessage()

func (*HasValidCredentialResponse) ProtoReflect added in v1.14.0

func (*HasValidCredentialResponse) Reset added in v1.14.0

func (x *HasValidCredentialResponse) Reset()

func (*HasValidCredentialResponse) String added in v1.14.0

func (x *HasValidCredentialResponse) String() string

type IDVSession

type IDVSession struct {

	// The ID of the IDVSession.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The Client Token for this IDVSession. This should be passed to your frontend to initiate
	// the IDV flow using Trinsic's Web SDK.
	ClientToken string `protobuf:"bytes,2,opt,name=client_token,json=clientToken,proto3" json:"client_token,omitempty"`
	// State of the IDVSession
	State IDVSessionState `protobuf:"varint,3,opt,name=state,proto3,enum=services.connect.v1.IDVSessionState" json:"state,omitempty"`
	// The actual Verifications to perform in this IDV flow
	Verifications map[string]*Verification `` /* 167-byte string literal not displayed */
	// The reason for the IDVSession's failure.
	// Only set if `state` is `IDV_FAILED`.
	FailCode *SessionFailCode `` /* 133-byte string literal not displayed */
	// The resultant signed VP combining the results of all verifications
	ResultVp *string `protobuf:"bytes,6,opt,name=result_vp,json=resultVp,proto3,oneof" json:"result_vp,omitempty"`
	// The unix timestamp, in seconds, that this IDVSession was created
	Created uint64 `protobuf:"fixed64,7,opt,name=created,proto3" json:"created,omitempty"`
	// The unix timestamp, in seconds, that this IDVSession's `state` was last updated
	Updated uint64 `protobuf:"fixed64,8,opt,name=updated,proto3" json:"updated,omitempty"`
	// contains filtered or unexported fields
}

An Identity Verification Session

func (*IDVSession) Descriptor deprecated

func (*IDVSession) Descriptor() ([]byte, []int)

Deprecated: Use IDVSession.ProtoReflect.Descriptor instead.

func (*IDVSession) GetClientToken

func (x *IDVSession) GetClientToken() string

func (*IDVSession) GetCreated

func (x *IDVSession) GetCreated() uint64

func (*IDVSession) GetFailCode

func (x *IDVSession) GetFailCode() SessionFailCode

func (*IDVSession) GetId

func (x *IDVSession) GetId() string

func (*IDVSession) GetResultVp

func (x *IDVSession) GetResultVp() string

func (*IDVSession) GetState

func (x *IDVSession) GetState() IDVSessionState

func (*IDVSession) GetUpdated

func (x *IDVSession) GetUpdated() uint64

func (*IDVSession) GetVerifications

func (x *IDVSession) GetVerifications() map[string]*Verification

func (*IDVSession) ProtoMessage

func (*IDVSession) ProtoMessage()

func (*IDVSession) ProtoReflect

func (x *IDVSession) ProtoReflect() protoreflect.Message

func (*IDVSession) Reset

func (x *IDVSession) Reset()

func (*IDVSession) String

func (x *IDVSession) String() string

type IDVSessionState

type IDVSessionState int32

The states a VerificationSession can be in

const (
	// Session has been created, but not yet shown to user
	IDVSessionState_IDV_CREATED IDVSessionState = 0
	// Session has been shown to user (iframe / popup opened), but
	// user has not yet logged in.
	IDVSessionState_IDV_INITIATED IDVSessionState = 1
	// User has entered their phone number, but not yet authenticated with the code sent via SMS
	IDVSessionState_IDV_AUTHENTICATING IDVSessionState = 2
	// User has been authenticated and is performing identity verification
	IDVSessionState_IDV_IN_PROGRESS IDVSessionState = 3
	// Session was completed successfully and IDV data is available to RP
	IDVSessionState_IDV_SUCCESS IDVSessionState = 4
	// The session failed; reason is present in `fail_code`.
	IDVSessionState_IDV_FAILED IDVSessionState = 5
)

func (IDVSessionState) Descriptor

func (IDVSessionState) Enum

func (x IDVSessionState) Enum() *IDVSessionState

func (IDVSessionState) EnumDescriptor deprecated

func (IDVSessionState) EnumDescriptor() ([]byte, []int)

Deprecated: Use IDVSessionState.Descriptor instead.

func (IDVSessionState) Number

func (IDVSessionState) String

func (x IDVSessionState) String() string

func (IDVSessionState) Type

type ListSessionsRequest added in v1.12.0

type ListSessionsRequest struct {

	// The field by which sessions should be sorted. Defaults to `CREATED`.
	OrderBy SessionOrdering `protobuf:"varint,1,opt,name=order_by,json=orderBy,proto3,enum=services.connect.v1.SessionOrdering" json:"order_by,omitempty"`
	// The order in which sessions should be sorted. Defaults to `ASCENDING`.
	OrderDirection common.OrderDirection `` /* 143-byte string literal not displayed */
	// The number of results to return per page.
	// Must be between `1` and `10`, inclusive.
	// Defaults to `10`.
	PageSize *int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3,oneof" json:"page_size,omitempty"`
	// The page index of results to return.
	// Starts at `1`.
	// Defaults to `1`.
	Page *int32 `protobuf:"varint,4,opt,name=page,proto3,oneof" json:"page,omitempty"`
	// contains filtered or unexported fields
}

Request to list all IDVSessions you've created

func (*ListSessionsRequest) Descriptor deprecated added in v1.12.0

func (*ListSessionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSessionsRequest.ProtoReflect.Descriptor instead.

func (*ListSessionsRequest) GetOrderBy added in v1.12.0

func (x *ListSessionsRequest) GetOrderBy() SessionOrdering

func (*ListSessionsRequest) GetOrderDirection added in v1.12.0

func (x *ListSessionsRequest) GetOrderDirection() common.OrderDirection

func (*ListSessionsRequest) GetPage added in v1.12.0

func (x *ListSessionsRequest) GetPage() int32

func (*ListSessionsRequest) GetPageSize added in v1.12.0

func (x *ListSessionsRequest) GetPageSize() int32

func (*ListSessionsRequest) ProtoMessage added in v1.12.0

func (*ListSessionsRequest) ProtoMessage()

func (*ListSessionsRequest) ProtoReflect added in v1.12.0

func (x *ListSessionsRequest) ProtoReflect() protoreflect.Message

func (*ListSessionsRequest) Reset added in v1.12.0

func (x *ListSessionsRequest) Reset()

func (*ListSessionsRequest) String added in v1.12.0

func (x *ListSessionsRequest) String() string

type ListSessionsResponse added in v1.12.0

type ListSessionsResponse struct {

	// The sessions you've created
	Sessions []*IDVSession `protobuf:"bytes,1,rep,name=sessions,proto3" json:"sessions,omitempty"`
	// The total number of sessions you've created
	Total int32 `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`
	// If `true`, this is not the last page of results.
	// If `false`, this is the last page of results.
	More bool `protobuf:"varint,3,opt,name=more,proto3" json:"more,omitempty"`
	// contains filtered or unexported fields
}

Response to `ListIDVSessionsRequest`

func (*ListSessionsResponse) Descriptor deprecated added in v1.12.0

func (*ListSessionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSessionsResponse.ProtoReflect.Descriptor instead.

func (*ListSessionsResponse) GetMore added in v1.12.0

func (x *ListSessionsResponse) GetMore() bool

func (*ListSessionsResponse) GetSessions added in v1.12.0

func (x *ListSessionsResponse) GetSessions() []*IDVSession

func (*ListSessionsResponse) GetTotal added in v1.12.0

func (x *ListSessionsResponse) GetTotal() int32

func (*ListSessionsResponse) ProtoMessage added in v1.12.0

func (*ListSessionsResponse) ProtoMessage()

func (*ListSessionsResponse) ProtoReflect added in v1.12.0

func (x *ListSessionsResponse) ProtoReflect() protoreflect.Message

func (*ListSessionsResponse) Reset added in v1.12.0

func (x *ListSessionsResponse) Reset()

func (*ListSessionsResponse) String added in v1.12.0

func (x *ListSessionsResponse) String() string

type NormalizedGovernmentIdData added in v1.13.0

type NormalizedGovernmentIdData struct {

	// The ID number of the underlying identity document
	IdNumber *string `protobuf:"bytes,1,opt,name=id_number,json=idNumber,proto3,oneof" json:"id_number,omitempty"`
	// Given ("first") name of the document holder
	GivenName *string `protobuf:"bytes,2,opt,name=given_name,json=givenName,proto3,oneof" json:"given_name,omitempty"`
	// Family ("last") name of the document holder
	FamilyName *string `protobuf:"bytes,3,opt,name=family_name,json=familyName,proto3,oneof" json:"family_name,omitempty"`
	// Full address of the document holder
	Address *string `protobuf:"bytes,4,opt,name=address,proto3,oneof" json:"address,omitempty"`
	// Date of birth of the document holder
	DateOfBirth *string `protobuf:"bytes,5,opt,name=date_of_birth,json=dateOfBirth,proto3,oneof" json:"date_of_birth,omitempty"`
	// ISO3 country code of the document
	Country *string `protobuf:"bytes,6,opt,name=country,proto3,oneof" json:"country,omitempty"`
	// Issuance date of the document
	IssueDate *string `protobuf:"bytes,7,opt,name=issue_date,json=issueDate,proto3,oneof" json:"issue_date,omitempty"`
	// Expiration date date of the document
	ExpirationDate *string `protobuf:"bytes,8,opt,name=expiration_date,json=expirationDate,proto3,oneof" json:"expiration_date,omitempty"`
	// contains filtered or unexported fields
}

func (*NormalizedGovernmentIdData) Descriptor deprecated added in v1.13.0

func (*NormalizedGovernmentIdData) Descriptor() ([]byte, []int)

Deprecated: Use NormalizedGovernmentIdData.ProtoReflect.Descriptor instead.

func (*NormalizedGovernmentIdData) GetAddress added in v1.13.0

func (x *NormalizedGovernmentIdData) GetAddress() string

func (*NormalizedGovernmentIdData) GetCountry added in v1.13.0

func (x *NormalizedGovernmentIdData) GetCountry() string

func (*NormalizedGovernmentIdData) GetDateOfBirth added in v1.13.0

func (x *NormalizedGovernmentIdData) GetDateOfBirth() string

func (*NormalizedGovernmentIdData) GetExpirationDate added in v1.13.0

func (x *NormalizedGovernmentIdData) GetExpirationDate() string

func (*NormalizedGovernmentIdData) GetFamilyName added in v1.13.0

func (x *NormalizedGovernmentIdData) GetFamilyName() string

func (*NormalizedGovernmentIdData) GetGivenName added in v1.13.0

func (x *NormalizedGovernmentIdData) GetGivenName() string

func (*NormalizedGovernmentIdData) GetIdNumber added in v1.13.0

func (x *NormalizedGovernmentIdData) GetIdNumber() string

func (*NormalizedGovernmentIdData) GetIssueDate added in v1.13.0

func (x *NormalizedGovernmentIdData) GetIssueDate() string

func (*NormalizedGovernmentIdData) ProtoMessage added in v1.13.0

func (*NormalizedGovernmentIdData) ProtoMessage()

func (*NormalizedGovernmentIdData) ProtoReflect added in v1.13.0

func (*NormalizedGovernmentIdData) Reset added in v1.13.0

func (x *NormalizedGovernmentIdData) Reset()

func (*NormalizedGovernmentIdData) String added in v1.13.0

func (x *NormalizedGovernmentIdData) String() string

type RequestedVerification

type RequestedVerification struct {

	// The type of verification to perform
	Type VerificationType `protobuf:"varint,1,opt,name=type,proto3,enum=services.connect.v1.VerificationType" json:"type,omitempty"`
	// Types that are assignable to Options:
	//
	//	*RequestedVerification_GovernmentIdOptions
	Options isRequestedVerification_Options `protobuf_oneof:"options"`
	// contains filtered or unexported fields
}

A verification to perform in an IDV flow

func (*RequestedVerification) Descriptor deprecated

func (*RequestedVerification) Descriptor() ([]byte, []int)

Deprecated: Use RequestedVerification.ProtoReflect.Descriptor instead.

func (*RequestedVerification) GetGovernmentIdOptions added in v1.13.0

func (x *RequestedVerification) GetGovernmentIdOptions() *GovernmentIDOptions

func (*RequestedVerification) GetOptions added in v1.13.0

func (m *RequestedVerification) GetOptions() isRequestedVerification_Options

func (*RequestedVerification) GetType

func (*RequestedVerification) ProtoMessage

func (*RequestedVerification) ProtoMessage()

func (*RequestedVerification) ProtoReflect

func (x *RequestedVerification) ProtoReflect() protoreflect.Message

func (*RequestedVerification) Reset

func (x *RequestedVerification) Reset()

func (*RequestedVerification) String

func (x *RequestedVerification) String() string

type RequestedVerification_GovernmentIdOptions added in v1.13.0

type RequestedVerification_GovernmentIdOptions struct {
	// Options for a Verification of type `GOVERNMENT_ID`
	GovernmentIdOptions *GovernmentIDOptions `protobuf:"bytes,2,opt,name=government_id_options,json=governmentIdOptions,proto3,oneof"`
}

type SessionFailCode

type SessionFailCode int32

The specific reason an IDVSession is in the `Failed` state

const (
	// The Session is not in a failure state.
	SessionFailCode_SESSION_FAIL_NONE SessionFailCode = 0
	// An internal Trinsic error caused this session to fail
	SessionFailCode_SESSION_FAIL_INTERNAL SessionFailCode = 1
	// The session failed because one or more of the verifications failed.
	// The reason for the failure is present in the `fail_reason` field of the relevant `Verification` object(s).
	SessionFailCode_SESSION_FAIL_VERIFICATION_FAILED SessionFailCode = 2
	// The session failed because the user failed to authenticate with their phone number too many times.
	SessionFailCode_SESSION_FAIL_AUTHENTICATION SessionFailCode = 3
	// The session expired
	SessionFailCode_SESSION_FAIL_EXPIRED SessionFailCode = 4
	// The user canceled / rejected the session
	SessionFailCode_SESSION_FAIL_USER_CANCELED SessionFailCode = 5
	// The RP canceled the session
	SessionFailCode_SESSION_FAIL_RP_CANCELED SessionFailCode = 6
)

func (SessionFailCode) Descriptor

func (SessionFailCode) Enum

func (x SessionFailCode) Enum() *SessionFailCode

func (SessionFailCode) EnumDescriptor deprecated

func (SessionFailCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SessionFailCode.Descriptor instead.

func (SessionFailCode) Number

func (SessionFailCode) String

func (x SessionFailCode) String() string

func (SessionFailCode) Type

type SessionOrdering added in v1.12.0

type SessionOrdering int32

Controls how sessions are ordered in `ListSessions`

const (
	// Order sessions according to when they were created
	SessionOrdering_CREATED SessionOrdering = 0
	// Order sessions according to when they last changed state
	SessionOrdering_UPDATED SessionOrdering = 1
	// Order sessions according to their numerical state
	SessionOrdering_STATE SessionOrdering = 2
)

func (SessionOrdering) Descriptor added in v1.12.0

func (SessionOrdering) Enum added in v1.12.0

func (x SessionOrdering) Enum() *SessionOrdering

func (SessionOrdering) EnumDescriptor deprecated added in v1.12.0

func (SessionOrdering) EnumDescriptor() ([]byte, []int)

Deprecated: Use SessionOrdering.Descriptor instead.

func (SessionOrdering) Number added in v1.12.0

func (SessionOrdering) String added in v1.12.0

func (x SessionOrdering) String() string

func (SessionOrdering) Type added in v1.12.0

type UnimplementedConnectServer

type UnimplementedConnectServer struct {
}

UnimplementedConnectServer must be embedded to have forward compatible implementations.

func (UnimplementedConnectServer) CancelSession

func (UnimplementedConnectServer) CreateSession

func (UnimplementedConnectServer) GetSession

func (UnimplementedConnectServer) HasValidCredential added in v1.14.0

func (UnimplementedConnectServer) ListSessions added in v1.12.0

type UnsafeConnectServer

type UnsafeConnectServer interface {
	// contains filtered or unexported methods
}

UnsafeConnectServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConnectServer will result in compilation errors.

type Verification

type Verification struct {

	// The ID of the verification
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The type of verification (driver's license, passport, proof of address, etc)
	Type VerificationType `protobuf:"varint,2,opt,name=type,proto3,enum=services.connect.v1.VerificationType" json:"type,omitempty"`
	// The state of the verification
	State VerificationState `protobuf:"varint,3,opt,name=state,proto3,enum=services.connect.v1.VerificationState" json:"state,omitempty"`
	// The reason for the Verification's failure.
	// Only set if `state` is `VERIFICATION_FAILED`.
	FailCode *VerificationFailCode `` /* 138-byte string literal not displayed */
	// Whether this was a reused (true) or fresh (false) verification.
	// If `state` is not `VERIFICATION_SUCCESS`, this field is `false` and does not convey useful information.
	Reused bool `protobuf:"varint,5,opt,name=reused,proto3" json:"reused,omitempty"`
	// The unix timestamp, in seconds, when this verification was begun
	// by the user -- or `0` if not yet begun.
	Begun uint64 `protobuf:"fixed64,6,opt,name=begun,proto3" json:"begun,omitempty"`
	// The unix timestamp, in seconds, when this verification last changed state -- or `0` if it has not yet
	// begun.
	Updated uint64 `protobuf:"fixed64,7,opt,name=updated,proto3" json:"updated,omitempty"`
	// The Government ID options for this Verification.
	// Only set if this Verification is of type `GOVERNMENT_ID`.
	GovernmentIdOptions *GovernmentIDOptions `` /* 126-byte string literal not displayed */
	// Normalized output for manual parsing and usage for this verification
	// Only set if this Verification is of type `GOVERNMENT_ID` and has succeeded.
	NormalizedGovernmentIdData *NormalizedGovernmentIdData `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

A Verification that is part of an IDVSession

func (*Verification) Descriptor deprecated

func (*Verification) Descriptor() ([]byte, []int)

Deprecated: Use Verification.ProtoReflect.Descriptor instead.

func (*Verification) GetBegun

func (x *Verification) GetBegun() uint64

func (*Verification) GetFailCode

func (x *Verification) GetFailCode() VerificationFailCode

func (*Verification) GetGovernmentIdOptions added in v1.13.0

func (x *Verification) GetGovernmentIdOptions() *GovernmentIDOptions

func (*Verification) GetId

func (x *Verification) GetId() string

func (*Verification) GetNormalizedGovernmentIdData added in v1.13.0

func (x *Verification) GetNormalizedGovernmentIdData() *NormalizedGovernmentIdData

func (*Verification) GetReused

func (x *Verification) GetReused() bool

func (*Verification) GetState

func (x *Verification) GetState() VerificationState

func (*Verification) GetType

func (x *Verification) GetType() VerificationType

func (*Verification) GetUpdated

func (x *Verification) GetUpdated() uint64

func (*Verification) ProtoMessage

func (*Verification) ProtoMessage()

func (*Verification) ProtoReflect

func (x *Verification) ProtoReflect() protoreflect.Message

func (*Verification) Reset

func (x *Verification) Reset()

func (*Verification) String

func (x *Verification) String() string

type VerificationFailCode

type VerificationFailCode int32

The specific reason a Verification is in the `Failed` state

const (
	// The verification is not in a failure state
	VerificationFailCode_VERIFICATION_FAIL_NONE VerificationFailCode = 0
	// An internal Trinsic error caused this verification to fail
	VerificationFailCode_VERIFICATION_FAIL_INTERNAL VerificationFailCode = 1
	// The image(s) provided for this verification were either too low-quality, not of the correct type, or otherwise
	// unable to be processed.
	// This failure reason is non-terminal; the user is able to retry the verification.
	VerificationFailCode_VERIFICATION_FAIL_INVALID_IMAGE VerificationFailCode = 2
	// The identity data/images provided are suspected to be inauthentic, fraudulent, or forged.
	VerificationFailCode_VERIFICATION_FAIL_INAUTHENTIC VerificationFailCode = 3
	// The document provided is either of an unsupported type, or from an unsupported country.
	VerificationFailCode_VERIFICATION_FAIL_UNSUPPORTED_DOCUMENT VerificationFailCode = 4
)

func (VerificationFailCode) Descriptor

func (VerificationFailCode) Enum

func (VerificationFailCode) EnumDescriptor deprecated

func (VerificationFailCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use VerificationFailCode.Descriptor instead.

func (VerificationFailCode) Number

func (VerificationFailCode) String

func (x VerificationFailCode) String() string

func (VerificationFailCode) Type

type VerificationState

type VerificationState int32

The states an individual Verification can be in

const (
	// This verification has not yet been performed in the flow
	VerificationState_VERIFICATION_PENDING VerificationState = 0
	// This verification has been started by the user, and can be reused from a previous verification, but the user
	// has not yet decided whether to reuse it.
	VerificationState_VERIFICATION_PENDING_REUSE VerificationState = 1
	// This verification has been started by the user, but not yet completed
	VerificationState_VERIFICATION_STARTED VerificationState = 2
	// This verification has been successfully completed
	VerificationState_VERIFICATION_SUCCESS VerificationState = 3
	// This verification has failed
	VerificationState_VERIFICATION_FAILED VerificationState = 4
)

func (VerificationState) Descriptor

func (VerificationState) Enum

func (VerificationState) EnumDescriptor deprecated

func (VerificationState) EnumDescriptor() ([]byte, []int)

Deprecated: Use VerificationState.Descriptor instead.

func (VerificationState) Number

func (VerificationState) String

func (x VerificationState) String() string

func (VerificationState) Type

type VerificationType

type VerificationType int32

The type of verification to perform

const (
	// Government-issued ID (driver's license, passport, etc)
	VerificationType_GOVERNMENT_ID VerificationType = 0
)

func (VerificationType) Descriptor

func (VerificationType) Enum

func (VerificationType) EnumDescriptor deprecated

func (VerificationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use VerificationType.Descriptor instead.

func (VerificationType) Number

func (VerificationType) String

func (x VerificationType) String() string

func (VerificationType) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL