Interface MobileCredentialSignStartEvent

interface MobileCredentialSignStartEventSanitised {
    category: "mobile-credential";
    data: {
        deviceKeyInfo: undefined;
        docType: string;
        includeStatus: undefined | boolean;
        itemsToSign: undefined;
        validityInfo: {
            expectedUpdate: undefined | string;
            validFrom: undefined | string;
            validUntil: string;
        };
    };
    id: string;
    requestId: string;
    tenantId: string;
    timestamp: number;
    type: string;
    version: "1";
}

Properties

category data id requestId tenantId timestamp type version

Properties

category

category: "mobile-credential"

Sanitisation Level DATA data

data: {
    docType: string;
    documentSignerId: undefined | string;
    includeStatus: undefined | boolean;
    payload: {
        deviceKeyInfo: {
            deviceKey: {
                crv: string;
                d: undefined | string;
                kid: undefined | string;
                kty: "OKP";
                x: undefined | string;
                y: undefined | string;
            } | {
                crv: string;
                d: undefined | string;
                kid: undefined | string;
                kty: "EC";
                x: undefined | string;
                y: undefined | string;
            } | {
                e: string;
                kty: "RSA";
                n: string;
            } | {
                d: string;
                dp: string;
                dq: string;
                e: string;
                kty: "RSA";
                n: string;
                p: string;
                q: string;
                qi: string;
            };
        };
        docType: string;
        itemsToSign: {
            [key: string]: {
                [key: string]: {
                    type: undefined | "boolean";
                    value: boolean;
                } | {
                    type: undefined | "number";
                    value: number;
                } | {
                    type: undefined | "string";
                    value: string;
                } | {
                    type: "binary";
                    value: string;
                } | {
                    type: "date";
                    value: string;
                } | {
                    type: "dateTime";
                    value: string;
                } | {
                    type: "object";
                    value: {
                        [key: string]: ClaimData;
                    };
                } | {
                    type: "array";
                    value: ClaimData[];
                } | {
                    type: "org.iso.18013.5.1.driving_privileges";
                    value: {
                        codes: undefined | {
                            code: ...;
                            sign: ...;
                            value: ...;
                        }[];
                        expiry_date: undefined | string;
                        issue_date: undefined | string;
                        vehicle_category_code: string;
                    }[];
                };
            };
        };
        validityInfo: {
            expectedUpdate: undefined | string;
            validFrom: undefined | string;
            validUntil: string;
        };
    };
}

Type declaration

  • docType: string
  • documentSignerId: undefined | string
  • includeStatus: undefined | boolean
  • payload: {
        deviceKeyInfo: {
            deviceKey: {
                crv: string;
                d: undefined | string;
                kid: undefined | string;
                kty: "OKP";
                x: undefined | string;
                y: undefined | string;
            } | {
                crv: string;
                d: undefined | string;
                kid: undefined | string;
                kty: "EC";
                x: undefined | string;
                y: undefined | string;
            } | {
                e: string;
                kty: "RSA";
                n: string;
            } | {
                d: string;
                dp: string;
                dq: string;
                e: string;
                kty: "RSA";
                n: string;
                p: string;
                q: string;
                qi: string;
            };
        };
        docType: string;
        itemsToSign: {
            [key: string]: {
                [key: string]: {
                    type: undefined | "boolean";
                    value: boolean;
                } | {
                    type: undefined | "number";
                    value: number;
                } | {
                    type: undefined | "string";
                    value: string;
                } | {
                    type: "binary";
                    value: string;
                } | {
                    type: "date";
                    value: string;
                } | {
                    type: "dateTime";
                    value: string;
                } | {
                    type: "object";
                    value: {
                        [key: string]: ClaimData;
                    };
                } | {
                    type: "array";
                    value: ClaimData[];
                } | {
                    type: "org.iso.18013.5.1.driving_privileges";
                    value: {
                        codes: undefined | {
                            code: ...;
                            sign: ...;
                            value: ...;
                        }[];
                        expiry_date: undefined | string;
                        issue_date: undefined | string;
                        vehicle_category_code: string;
                    }[];
                };
            };
        };
        validityInfo: {
            expectedUpdate: undefined | string;
            validFrom: undefined | string;
            validUntil: string;
        };
    }
    • deviceKeyInfo: {
          deviceKey: {
              crv: string;
              d: undefined | string;
              kid: undefined | string;
              kty: "OKP";
              x: undefined | string;
              y: undefined | string;
          } | {
              crv: string;
              d: undefined | string;
              kid: undefined | string;
              kty: "EC";
              x: undefined | string;
              y: undefined | string;
          } | {
              e: string;
              kty: "RSA";
              n: string;
          } | {
              d: string;
              dp: string;
              dq: string;
              e: string;
              kty: "RSA";
              n: string;
              p: string;
              q: string;
              qi: string;
          };
      }
      • deviceKey: {
            crv: string;
            d: undefined | string;
            kid: undefined | string;
            kty: "OKP";
            x: undefined | string;
            y: undefined | string;
        } | {
            crv: string;
            d: undefined | string;
            kid: undefined | string;
            kty: "EC";
            x: undefined | string;
            y: undefined | string;
        } | {
            e: string;
            kty: "RSA";
            n: string;
        } | {
            d: string;
            dp: string;
            dq: string;
            e: string;
            kty: "RSA";
            n: string;
            p: string;
            q: string;
            qi: string;
        }
    • docType: string
    • itemsToSign: {
          [key: string]: {
              [key: string]: {
                  type: undefined | "boolean";
                  value: boolean;
              } | {
                  type: undefined | "number";
                  value: number;
              } | {
                  type: undefined | "string";
                  value: string;
              } | {
                  type: "binary";
                  value: string;
              } | {
                  type: "date";
                  value: string;
              } | {
                  type: "dateTime";
                  value: string;
              } | {
                  type: "object";
                  value: {
                      [key: string]: ClaimData;
                  };
              } | {
                  type: "array";
                  value: ClaimData[];
              } | {
                  type: "org.iso.18013.5.1.driving_privileges";
                  value: {
                      codes: undefined | {
                          code: ...;
                          sign: ...;
                          value: ...;
                      }[];
                      expiry_date: undefined | string;
                      issue_date: undefined | string;
                      vehicle_category_code: string;
                  }[];
              };
          };
      }
      • [key: string]: {
            [key: string]: {
                type: undefined | "boolean";
                value: boolean;
            } | {
                type: undefined | "number";
                value: number;
            } | {
                type: undefined | "string";
                value: string;
            } | {
                type: "binary";
                value: string;
            } | {
                type: "date";
                value: string;
            } | {
                type: "dateTime";
                value: string;
            } | {
                type: "object";
                value: {
                    [key: string]: ClaimData;
                };
            } | {
                type: "array";
                value: ClaimData[];
            } | {
                type: "org.iso.18013.5.1.driving_privileges";
                value: {
                    codes: undefined | {
                        code: ...;
                        sign: ...;
                        value: ...;
                    }[];
                    expiry_date: undefined | string;
                    issue_date: undefined | string;
                    vehicle_category_code: string;
                }[];
            };
        }
        • [key: string]: {
              type: undefined | "boolean";
              value: boolean;
          } | {
              type: undefined | "number";
              value: number;
          } | {
              type: undefined | "string";
              value: string;
          } | {
              type: "binary";
              value: string;
          } | {
              type: "date";
              value: string;
          } | {
              type: "dateTime";
              value: string;
          } | {
              type: "object";
              value: {
                  [key: string]: ClaimData;
              };
          } | {
              type: "array";
              value: ClaimData[];
          } | {
              type: "org.iso.18013.5.1.driving_privileges";
              value: {
                  codes: undefined | {
                      code: ...;
                      sign: ...;
                      value: ...;
                  }[];
                  expiry_date: undefined | string;
                  issue_date: undefined | string;
                  vehicle_category_code: string;
              }[];
          }
    • validityInfo: {
          expectedUpdate: undefined | string;
          validFrom: undefined | string;
          validUntil: string;
      }
      • expectedUpdate: undefined | string
      • validFrom: undefined | string
      • validUntil: string

id

id: string

requestId

requestId: string

tenantId

tenantId: string

timestamp

timestamp: number

type

type: string

version

version: "1"

Settings

Member Visibility

Theme

On This Page

categorydataidrequestIdtenantIdtimestamptypeversion