Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update SDK Proto #176

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions proto/services/connect/v1/connect.proto
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import "services/common/v1/common.proto";
import "services/universal-wallet/v1/universal-wallet.proto";

import "services/google/api/annotations.proto";
import "services/options/field-options.proto";

// The type of verification to perform
enum VerificationType {
Expand Down Expand Up @@ -43,11 +44,13 @@ enum IDVSessionState {
enum VerificationState {
// This verification has not yet been performed in the flow
VERIFICATION_PENDING = 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.
VERIFICATION_PENDING_REUSE = 1;
// This verification has been started by the user, but not yet completed
VERIFICATION_STARTED = 2;

reserved 1;
reserved "VERIFICATION_PENDING_REUSE";

reserved 2;
reserved "VERIFICATION_STARTED";

// This verification has been successfully completed
VERIFICATION_SUCCESS = 3;
// This verification has failed
Expand Down Expand Up @@ -126,10 +129,16 @@ message IDVSession {

// The unix timestamp, in seconds, that this IDVSession's `state` was last updated
fixed64 updated = 8;

// Whether this session was redacted or not
optional bool redacted = 9;
}

// A Verification that is part of an IDVSession
message Verification {
reserved 6;
reserved "begun";

// The ID of the verification
string id = 1;

Expand All @@ -147,10 +156,6 @@ message Verification {
// If `state` is not `VERIFICATION_SUCCESS`, this field is `false` and does not convey useful information.
bool reused = 5;

// The unix timestamp, in seconds, when this verification was begun
// by the user -- or `0` if not yet begun.
fixed64 begun = 6;

// The unix timestamp, in seconds, when this verification last changed state -- or `0` if it has not yet
// begun.
fixed64 updated = 7;
Expand Down Expand Up @@ -251,6 +256,18 @@ message GovernmentIDFields {

// Expiration date date of the document
bool expiration_date = 8;

// The image of the front of the document
bool document_front = 9;

// The image of the back of the document
bool document_back = 10;

// The image of the holder portrait contained in the document
bool document_portrait = 11;

// The image of the face match selfie
bool selfie = 12;
}

// Response to `CreateIDVSessionRequest`
Expand Down Expand Up @@ -353,6 +370,7 @@ enum SessionOrdering {
service Connect {
// Create an IDVSession
rpc CreateSession(CreateSessionRequest) returns (CreateSessionResponse) {
option (options.sdk_template_option).deprecated = {active: true};
option (google.api.http) = {
post: "/v1/connect/createsession"
body: "*"
Expand All @@ -361,6 +379,7 @@ service Connect {

// Cancel an IDVSession
rpc CancelSession(CancelSessionRequest) returns (CancelSessionResponse) {
option (options.sdk_template_option).deprecated = {active: true};
option (google.api.http) = {
post: "/v1/connect/cancelsession"
body: "*"
Expand All @@ -369,6 +388,7 @@ service Connect {

// Get an IDVSession
rpc GetSession(GetSessionRequest) returns (GetSessionResponse) {
option (options.sdk_template_option).deprecated = {active: true};
option (google.api.http) = {
post: "/v1/connect/getsession"
body: "*"
Expand All @@ -377,6 +397,7 @@ service Connect {

// List IDVSessions created by the calling wallet
rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse) {
option (options.sdk_template_option).deprecated = {active: true};
option (google.api.http) = {
post: "/v1/connect/listsessions"
body: "*"
Expand All @@ -385,6 +406,7 @@ service Connect {

// Checks if the identity provided in the request has a wallet containing a valid reusable credential
rpc HasValidCredential(HasValidCredentialRequest) returns (HasValidCredentialResponse) {
option (options.sdk_template_option).deprecated = {active: true};
option (google.api.http) = {
post: "/v1/connect/hasvalidcredential"
body: "*"
Expand Down
Loading