identity

Documentation

Overview

Package identity provides types for capturing and validating an identity check.

Index

• Variables
• type Status
  • func ParseStatus(s string) (Status, error)
  • func (i Status) IsConfirmed() bool
  • func (i Status) IsExpired() bool
  • func (i Status) IsFailed() bool
  • func (i Status) IsInsufficientEvidence() bool
  • func (i Status) IsUnknown() bool
  • func (i Status) MarshalText() ([]byte, error)
  • func (i Status) String() string
  • func (i *Status) UnmarshalText(text []byte) error
• type StatusOptions
• type UserData
  • func (u UserData) MatchName(firstNames, lastName string) bool

Variables

var StatusValues = StatusOptions{
	Unknown:              StatusUnknown,
	Confirmed:            StatusConfirmed,
	Failed:               StatusFailed,
	InsufficientEvidence: StatusInsufficientEvidence,
	Expired:              StatusExpired,
}

Types

type Status

type Status uint8

const (
	StatusUnknown              Status = iota // unknown
	StatusConfirmed                          // confirmed
	StatusFailed                             // failed
	StatusInsufficientEvidence               // insufficient-evidence
	StatusExpired                            // expired
)

func ParseStatus

func ParseStatus(s string) (Status, error)

func (Status) IsConfirmed

func (i Status) IsConfirmed() bool

func (Status) IsExpired

func (i Status) IsExpired() bool

func (Status) IsFailed

func (i Status) IsFailed() bool

func (Status) IsInsufficientEvidence

func (i Status) IsInsufficientEvidence() bool

func (Status) IsUnknown

func (i Status) IsUnknown() bool

func (Status) MarshalText

func (i Status) MarshalText() ([]byte, error)

func (Status) String

func (i Status) String() string

func (*Status) UnmarshalText

func (i *Status) UnmarshalText(text []byte) error

type StatusOptions

type StatusOptions struct {
	Unknown              Status
	Confirmed            Status
	Failed               Status
	InsufficientEvidence Status
	Expired              Status
}

type UserData

type UserData struct {
	Status         Status
	FirstNames     string
	LastName       string
	DateOfBirth    date.Date
	CurrentAddress place.Address
	// RetrievedAt records when identity information was taken from OneLogin.
	RetrievedAt time.Time
	// VouchedAt records when a voucher confirmed the identity information, if the
	// donor is getting someone to vouch for them.
	VouchedAt time.Time
}

func (UserData) MatchName

func (u UserData) MatchName(firstNames, lastName string) bool