synaps

Documentation

Index

• Constants
• func GetSessionId(alias string) (string, error)
• type SessionDetails
  • func GetSessionDetails(sessionId string) (SessionDetails, error)
  • func (s *SessionDetails) IsVerified() bool
• type SessionInfo
  • func GetFinishedSessions() ([]SessionInfo, error)
  • func GetPendingSessions() ([]SessionInfo, error)

Constants

const (
	REQUEST_METHOD_POST = "POST"
	REQUEST_METHOD_GET  = "GET"

	SESSION_ID    = "session_id"
	SESSION_ALIAS = "alias"

	API_SESSION_INIT            = "/session/init"
	API_SESSION_INIT_WITH_ALIAS = "/session/init?alias=%s"
	API_SESSION_FINISHED        = "/session/list/FINISHED"
	API_SESSION_PENDING         = "/session/list/PENDING"
	API_SESSION_DETAILS         = "/onboarding/details"

	API_HEADER_SESSION_ID = "Session-Id"
	API_HEADER_API_KEY    = "Api-Key"
	API_HEADER_CLIENT_ID  = "Client-Id"

	VERIFICATION_STEP_IDENTITY = "IDENTITY"
	VERIFICATION_STEP_LIVENESS = "LIVENESS"

	VERIFICATION_STATE_VALIDATED = "VALIDATED"
	VERIFICATION_STATE_PENDING   = "PENDING"
)

Functions

func GetSessionId

func GetSessionId(alias string) (string, error)

This function receives a string named alias which is used as a user id and it calls synaps API to initiate a new session, it then returns a session id

Types

type SessionDetails

type SessionDetails struct {
	SessionInfo
	Steps map[string]struct {
		Verification struct {
			State string `json:"state"`
		} `json:"verification"`

		Type string `json:"type"`
	} `json:"steps"`
}

func GetSessionDetails

func GetSessionDetails(sessionId string) (SessionDetails, error)

func (*SessionDetails) IsVerified

func (s *SessionDetails) IsVerified() bool

type SessionInfo

type SessionInfo struct {
	SessionId string `json:"session_id"`
	Sandbox   bool   `json:"sandbox"`
	Status    string `json:"status"`
	Alias     string `json:"alias"`
}

func GetFinishedSessions

func GetFinishedSessions() ([]SessionInfo, error)

This function retrieves the finished sessions i.e. Information of the users who have their verification process finalized

func GetPendingSessions

func GetPendingSessions() ([]SessionInfo, error)

This function retrieves the sessions which have an ongoing verification process