models_sumsub

Documentation

Index

• Variables
• type AccessToken
• type Applicant
• type FixedInfo
• type IdDoc
• type IdDocType
  • func ParseIdDocType(s string) (IdDocType, error)
  • func (s IdDocType) String() string
• type RawAddress
• type WebhookResponse

Variables

var DocumentTypeToIdDocType = map[string]IdDocType{
	constants.DOCUMENT_TYPE_PASSPORT:            Passport,
	constants.DOCUMENT_TYPE_DRIVER_LICENSE:      Drivers,
	constants.DOCUMENT_TYPE_ID_CARD:             IDCard,
	constants.DOCUMENT_TYPE_UTILITY_BILL:        UtilityBill,
	constants.DOCUMENT_TYPE_BANK_STATEMENT:      BankCard,
	constants.DOCUMENT_TYPE_TAX_DOCUMENT:        IncomeSource,
	constants.DOCUMENT_TYPE_PROOF_OF_ADDRESS:    ResidencePermit,
	constants.DOCUMENT_TYPE_FINANCIAL_STATEMENT: Agreement,
	constants.DOCUMENT_TYPE_SELFIE:              Selfie,
	constants.DOCUMENT_TYPE_VIDEO_SELFIE:        VideoSelfie,
	constants.DOCUMENT_TYPE_OTHER:               Other,
}

map document type to idDocType

var IdDocTypeToString = map[IdDocType]string{
	IDCard:                         constants.SUMSUB_ID_DOC_TYPE_ID_CARD,
	Passport:                       constants.SUMSUB_ID_DOC_TYPE_PASSPORT,
	Drivers:                        constants.SUMSUB_ID_DOC_TYPE_DRIVERS,
	ResidencePermit:                constants.SUMSUB_ID_DOC_TYPE_RESIDENCE_PERMIT,
	UtilityBill:                    constants.SUMSUB_ID_DOC_TYPE_UTILITY_BILL,
	Selfie:                         constants.SUMSUB_ID_DOC_TYPE_SELFIE,
	VideoSelfie:                    constants.SUMSUB_ID_DOC_TYPE_VIDEO_SELFIE,
	ProfileImage:                   constants.SUMSUB_ID_DOC_TYPE_PROFILE_IMAGE,
	IdDocPhoto:                     constants.SUMSUB_ID_DOC_TYPE_ID_DOC_PHOTO,
	Agreement:                      constants.SUMSUB_ID_DOC_TYPE_AGREEMENT,
	Contract:                       constants.SUMSUB_ID_DOC_TYPE_CONTRACT,
	DriversTranslation:             constants.SUMSUB_ID_DOC_TYPE_DRIVERS_TRANSLATION,
	InvesterDoc:                    constants.SUMSUB_ID_DOC_TYPE_INVESTER_DOC,
	VehicleRegistrationCertificate: constants.SUMSUB_ID_DOC_TYPE_VEHICLE_REGISTRATION_CERTIFICATE,
	IncomeSource:                   constants.SUMSUB_ID_DOC_TYPE_INCOME_SOURCE,
	PaymentMethod:                  constants.SUMSUB_ID_DOC_TYPE_PAYMENT_METHOD,
	BankCard:                       constants.SUMSUB_ID_DOC_TYPE_BANK_CARD,
	CovidVaccinationForm:           constants.SUMSUB_ID_DOC_TYPE_COVID_VACCINATION_FORM,
	ArbitraryDoc:                   constants.SUMSUB_ID_DOC_TYPE_ARBITRARY_DOC,
	Other:                          constants.SUMSUB_ID_DOC_TYPE_OTHER,
}

Map enum values to their string representations

var StringToIdDocType = map[string]IdDocType{
	constants.SUMSUB_ID_DOC_TYPE_ID_CARD:                          IDCard,
	constants.SUMSUB_ID_DOC_TYPE_PASSPORT:                         Passport,
	constants.SUMSUB_ID_DOC_TYPE_DRIVERS:                          Drivers,
	constants.SUMSUB_ID_DOC_TYPE_RESIDENCE_PERMIT:                 ResidencePermit,
	constants.SUMSUB_ID_DOC_TYPE_UTILITY_BILL:                     UtilityBill,
	constants.SUMSUB_ID_DOC_TYPE_SELFIE:                           Selfie,
	constants.SUMSUB_ID_DOC_TYPE_VIDEO_SELFIE:                     VideoSelfie,
	constants.SUMSUB_ID_DOC_TYPE_PROFILE_IMAGE:                    ProfileImage,
	constants.SUMSUB_ID_DOC_TYPE_ID_DOC_PHOTO:                     IdDocPhoto,
	constants.SUMSUB_ID_DOC_TYPE_AGREEMENT:                        Agreement,
	constants.SUMSUB_ID_DOC_TYPE_CONTRACT:                         Contract,
	constants.SUMSUB_ID_DOC_TYPE_DRIVERS_TRANSLATION:              DriversTranslation,
	constants.SUMSUB_ID_DOC_TYPE_INVESTER_DOC:                     InvesterDoc,
	constants.SUMSUB_ID_DOC_TYPE_VEHICLE_REGISTRATION_CERTIFICATE: VehicleRegistrationCertificate,
	constants.SUMSUB_ID_DOC_TYPE_INCOME_SOURCE:                    IncomeSource,
	constants.SUMSUB_ID_DOC_TYPE_PAYMENT_METHOD:                   PaymentMethod,
	constants.SUMSUB_ID_DOC_TYPE_BANK_CARD:                        BankCard,
	constants.SUMSUB_ID_DOC_TYPE_COVID_VACCINATION_FORM:           CovidVaccinationForm,
	constants.SUMSUB_ID_DOC_TYPE_ARBITRARY_DOC:                    ArbitraryDoc,
	constants.SUMSUB_ID_DOC_TYPE_OTHER:                            Other,
}

Map string representations back to enum values

Types

type AccessToken

type AccessToken struct {
	Token  string `json:"token"`
	UserId string `json:"userId"`
}

type Applicant

type Applicant struct {
	ID                string    `json:"id,omitempty"`
	CreatedAt         string    `json:"createdAt,omitempty"`
	CreatedBy         string    `json:"createdBy,omitempty"`
	Key               string    `json:"sourceKey,omitempty"`
	ClientID          string    `json:"clientId,omitempty"`
	InspectionID      string    `json:"inspectionId,omitempty"`
	ExternalUserID    string    `json:"externalUserId,omitempty"`
	Info              FixedInfo `json:"info,omitempty"`
	FixedInfo         FixedInfo `json:"fixedInfo,omitempty"`
	ApplicantPlatform string    `json:"applicantPlatform,omitempty"`
	RequiredIdDocs    struct {
		DocSets []struct {
			IdDocSetType  string   `json:"idDocSetType,omitempty"`
			Types         []string `json:"idDocType,omitempty"`
			VideoRequired string   `json:"videoRequired,omitempty"`
		} `json:"docSets,omitempty"`
	} `json:"requiredIdDocs,omitempty"`
	Review struct {
		ReviewID              string    `json:"reviewId,omitempty"`
		AttemptID             string    `json:"attemptId,omitempty"`
		AttemptCnt            int       `json:"attemptCnt,omitempty"`
		LevelName             string    `json:"levelName,omitempty"`
		LevelAutoCheckMode    string    `json:"levelAutoCheckMode,omitempty"`
		CreateDate            string    `json:"createDate,omitempty"`
		ReviewStatus          string    `json:"reviewStatus,omitempty"`
		Priority              int       `json:"priority,omitempty"`
		ElapsedSincePendingMs int       `json:"elapsedSincePendingMs,omitempty"`
		ElapsedSinceQueuedMs  int       `json:"elapsedSinceQueuedMs,omitempty"`
		Reprocessing          bool      `json:"reprocessing,omitempty"`
		ReviewDate            time.Time `json:"reviewDate,omitempty"`
		StartDate             string    `json:"startDate,omitempty"`
		ReviewResult          struct {
			ReviewAnswer string `json:"reviewAnswer,omitempty"`
		} `json:"reviewResult,omitempty"`
		NotificationFailureCnt int `json:"notificationFailureCnt,omitempty"`
	} `json:"review,omitempty"`
	Lang            string          `json:"lang,omitempty"`
	Type            string          `json:"type,omitempty"`
	WebhookResponse WebhookResponse `json:"webhookResponse,omitempty"`
}

type FixedInfo

type FixedInfo struct {
	FirstName  string       `json:"firstName,omitempty"`
	MiddleName string       `json:"middleName,omitempty"`
	LastName   string       `json:"lastName,omitempty"`
	Dob        string       `json:"dob,omitempty"` //yyyy-mm-dd format
	Gender     string       `json:"gender,omitempty"`
	Country    string       `json:"country,omitempty"`
	Addresses  []RawAddress `json:"addresses,omitempty"`
}

type IdDoc

type IdDoc struct {
	IdDocType    string `json:"idDocType,omitempty"`
	Country      string `json:"country,omitempty"`
	FirstName    string `json:"firstName,omitempty"`
	FirstNameEn  string `json:"firstNameEn,omitempty"`
	MiddleName   string `json:"middleName,omitempty"`
	MiddleNameEn string `json:"middleNameEn,omitempty"`
	LastName     string `json:"lastName,omitempty"`
	LastNameEn   string `json:"lastNameEn,omitempty"`
	DateOfBirth  string `json:"dob,omitempty"` // yyyy-mm-dd format
}

type IdDocType

type IdDocType int

const (
	IDCard IdDocType = iota
	Passport
	Drivers
	ResidencePermit
	UtilityBill
	Selfie
	VideoSelfie
	ProfileImage
	IdDocPhoto
	Agreement
	Contract
	DriversTranslation
	InvesterDoc
	VehicleRegistrationCertificate
	IncomeSource
	PaymentMethod
	BankCard
	CovidVaccinationForm
	ArbitraryDoc
	Other
)

Enum values for IdDocType, source: https://developers.sumsub.com/api-reference/#id-documents

func ParseIdDocType

func ParseIdDocType(s string) (IdDocType, error)

Parse string to Status enum

func (IdDocType) String

func (s IdDocType) String() string

String method for Status to get the name

type RawAddress

type RawAddress struct {
	Line1      string `json:"street,omitempty"`
	Line2      string `json:"flatNumber,omitempty"`
	City       string `json:"town"`
	Region     string `json:"state"`
	PostalCode string `json:"postCode"`
	Country    string `json:"country"`
}

Address represents the address fields

type WebhookResponse

type WebhookResponse struct {
	ApplicantID    string `json:"applicantId,omitempty"`
	InspectionID   string `json:"inspectionId,omitempty"`
	CorrelationID  string `json:"correlationId,omitempty"`
	LevelName      string `json:"levelName,omitempty"`
	ExternalUserID string `json:"externalUserId,omitempty"`
	Type           string `json:"type,omitempty"`
	SandboxMode    bool   `json:"sandboxMode,omitempty"`
	ReviewStatus   string `json:"reviewStatus,omitempty"`
	CreatedAtMs    string `json:"createdAtMs,omitempty"`
	ClientID       string `json:"clientId,omitempty"`
	ApplicantType  string `json:"applicantType,omitempty"`
	ReviewResult   struct {
		ReviewAnswer     string   `json:"reviewAnswer,omitempty"`
		RejectLabels     []string `json:"rejectLabels,omitempty"`
		ReviewRejectType string   `json:"reviewRejectType,omitempty"`
		ButtonIds        []string `json:"buttonIds,omitempty"`
	} `json:"reviewResult,omitempty"`
	ApplicantActionID         string `json:"applicantActionId,omitempty"`
	ExternalApplicantActionID string `json:"externalApplicantActionId,omitempty"`
}