Namirial · Schema

EnvelopeGetResponse

The response model for requesting the envelope overview.

CompanyDigital TrustE-SignatureIdentity VerificationDigital IdentityTrust ServicesCompliance

Properties

Name Type Description
Id string The identifier of the envelope.
EnvelopeStatus string The status of the envelope.
Name string The name of the envelope.
SentDate string Date when the envelope was sent.
EnvelopeBulkParentId string The identifier of the BulkParent.
Activities array The steps for the envelope.
SenderUserInformation object The information about the user who sent the envelope.
View JSON Schema on GitHub

JSON Schema

namirial-envelope-get-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/namirial/json-schema/namirial-envelope-get-response-schema.json",
  "title": "EnvelopeGetResponse",
  "description": "The response model for requesting the envelope overview.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/namirial-envelope-api-openapi.yml#/components/schemas/EnvelopeGetResponse",
  "type": "object",
  "properties": {
    "Id": {
      "description": "The identifier of the envelope.",
      "type": "string"
    },
    "EnvelopeStatus": {
      "description": "The status of the envelope.",
      "enum": [
        "Active",
        "Completed",
        "Canceled",
        "Expired",
        "Rejected"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "EnvelopeStatusExternal",
        "modelAsString": false
      }
    },
    "Name": {
      "description": "The name of the envelope.",
      "type": "string"
    },
    "SentDate": {
      "format": "date-time",
      "description": "Date when the envelope was sent.",
      "type": "string"
    },
    "EnvelopeBulkParentId": {
      "description": "The identifier of the BulkParent.",
      "type": "string"
    },
    "Activities": {
      "description": "The steps for the envelope.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/EnvelopeGetActivity"
      }
    },
    "SenderUserInformation": {
      "$ref": "#/$defs/EnvelopeGetSenderUserInformation",
      "description": "The information about the user who sent the envelope."
    }
  },
  "$defs": {
    "EnvelopeGetAction": {
      "description": "The action of the activity.",
      "type": "object",
      "properties": {
        "SendCopy": {
          "$ref": "#/$defs/EnvelopeGetSendCopy",
          "description": "The definition of the copy action."
        },
        "SignAutomatic": {
          "$ref": "#/$defs/EnvelopeGetSignAutomatic",
          "description": "The definition of the automatic sign action."
        },
        "Sign": {
          "$ref": "#/$defs/EnvelopeGetSign",
          "description": "The definition of the sign action."
        },
        "View": {
          "$ref": "#/$defs/EnvelopeGetView",
          "description": "The definition of the view action."
        },
        "SignAsP7M": {
          "$ref": "#/$defs/EnvelopeGetSignAsP7M",
          "description": "The definition of the P7M sign action."
        }
      }
    },
    "EnvelopeGetActivity": {
      "description": "An activity in the process.",
      "type": "object",
      "properties": {
        "Id": {
          "description": "The identifier of the activity.",
          "type": "string"
        },
        "Status": {
          "description": "The status of an action within the envelope.",
          "enum": [
            "Pending",
            "Completed",
            "Rejected",
            "Delegated"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "EnvelopeGetActivityStatus",
            "modelAsString": false
          }
        },
        "StatusReason": {
          "description": "Additional information why this particular status was reached.",
          "type": "string"
        },
        "FinishedDate": {
          "format": "date-time",
          "description": "The date when the action was finished.\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).",
          "type": "string"
        },
        "OpenedDate": {
          "format": "date-time",
          "description": "The date when the action was accessed.\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).",
          "type": "string"
        },
        "Action": {
          "$ref": "#/$defs/EnvelopeGetAction",
          "description": "The action assigned to the activity."
        }
      }
    },
    "EnvelopeGetContactInformation": {
      "description": "Defines the contact information for the recipient.",
      "type": "object",
      "properties": {
        "Email": {
          "description": "The email address of the recipient.",
          "type": "string"
        },
        "GivenName": {
          "description": "The given name of the recipient.",
          "type": "string"
        },
        "Surname": {
          "description": "The surname of the recipient.",
          "type": "string"
        },
        "PhoneNumber": {
          "description": "The phone number of the recipient.",
          "type": "string"
        },
        "LanguageCode": {
          "description": "The language of the recipient.",
          "enum": [
            "AF",
            "AF_ZA",
            "AR",
            "AR_AE",
            "AR_BH",
            "AR_DZ",
            "AR_EG",
            "AR_IQ",
            "AR_JO",
            "AR_KW",
            "AR_LB",
            "AR_LY",
            "AR_MA",
            "AR_OM",
            "AR_QA",
            "AR_SA",
            "AR_SY",
            "AR_TN",
            "AR_YE",
            "AZ",
            "BE",
            "BE_BY",
            "BG",
            "BG_BG",
            "CA",
            "CA_ES",
            "CS",
            "CS_CZ",
            "CY",
            "CY_GB",
            "DA",
            "DA_DK",
            "DE",
            "DE_AT",
            "DE_CH",
            "DE_DE",
            "DE_LI",
            "DE_LU",
            "DV",
            "DV_MV",
            "EL",
            "EL_GR",
            "EN",
            "EN_AU",
            "EN_BZ",
            "EN_CA",
            "EN_GB",
            "EN_IE",
            "EN_JM",
            "EN_NZ",
            "EN_PH",
            "EN_TT",
            "EN_US",
            "EN_ZA",
            "EN_ZW",
            "ES",
            "ES_AR",
            "ES_BO",
            "ES_CL",
            "ES_CO",
            "ES_CR",
            "ES_DO",
            "ES_EC",
            "ES_ES",
            "ES_GT",
            "ES_HN",
            "ES_MX",
            "ES_NI",
            "ES_PA",
            "ES_PE",
            "ES_PR",
            "ES_PY",
            "ES_SV",
            "ES_UY",
            "ES_VE",
            "ET",
            "ET_EE",
            "EU",
            "EU_ES",
            "FA",
            "FA_IR",
            "FI",
            "FI_FI",
            "FO",
            "FO_FO",
            "FR",
            "FR_BE",
            "FR_CA",
            "FR_CH",
            "FR_FR",
            "FR_LU",
            "FR_MC",
            "GL",
            "GL_ES",
            "GU",
            "GU_IN",
            "HE",
            "HE_IL",
            "HI",
            "HI_IN",
            "HR",
            "HR_BA",
            "HR_HR",
            "HU",
            "HU_HU",
            "HY",
            "HY_AM",
            "ID",
            "ID_ID",
            "IS",
            "IS_IS",
            "IT",
            "IT_CH",
            "IT_IT",
            "JA",
            "JA_JP",
            "KA",
            "KA_GE",
            "KK",
            "KK_KZ",
            "KN",
            "KN_IN",
            "KO",
            "KO_KR",
            "KOK",
            "KOK_IN",
            "KY",
            "KY_KG",
            "LT",
            "LT_LT",
            "LV",
            "LV_LV",
            "MI",
            "MI_NZ",
            "MK",
            "MK_MK",
            "MN",
            "MN_MN",
            "MR",
            "MR_IN",
            "MS",
            "MS_BN",
            "MS_MY",
            "MT",
            "MT_MT",
            "NB",
            "NB_NO",
            "NL",
            "NL_BE",
            "NL_NL",
            "NN_NO",
            "PA",
            "PA_IN",
            "PL",
            "PL_PL",
            "PS",
            "PT",
            "PT_BR",
            "PT_PT",
            "RO",
            "RO_RO",
            "RU",
            "RU_RU",
            "SA",
            "SA_IN",
            "SE",
            "SE_FI",
            "SE_NO",
            "SE_SE",
            "SK",
            "SK_SK",
            "SL",
            "SL_SI",
            "SQ",
            "SQ_AL",
            "SV",
            "SV_FI",
            "SV_SE",
            "SW",
            "SW_KE",
            "SYR",
            "SYR_SY",
            "TA",
            "TA_IN",
            "TE",
            "TE_IN",
            "TH",
            "TH_TH",
            "TN",
            "TN_ZA",
            "TR",
            "TR_TR",
            "TT",
            "TT_RU",
            "TS",
            "UK",
            "UK_UA",
            "UR",
            "UR_PK",
            "UZ",
            "VI",
            "VI_VN",
            "XH",
            "XH_ZA",
            "ZH",
            "ZH_CN",
            "ZH_HK",
            "ZH_MO",
            "ZH_SG",
            "ZH_TW",
            "ZU",
            "ZU_ZA",
            "AM",
            "AM_ET",
            "ARN",
            "ARN_CL",
            "AS",
            "AS_IN",
            "AZ_CYRL",
            "AZ_CYRL_AZ",
            "AZ_LATN",
            "AZ_LATN_AZ",
            "BA",
            "BA_RU",
            "BN",
            "BN_BD",
            "BN_IN",
            "BO",
            "BO_CN",
            "BR",
            "BR_FR",
            "BS",
            "BS_CYRL",
            "BS_CYRL_BA",
            "BS_LATN",
            "BS_LATN_BA",
            "CA_ES_VALENCIA",
            "CHR",
            "CHR_CHER",
            "CHR_CHER_US",
            "CO",
            "CO_FR",
            "DSB",
            "DSB_DE",
            "EN_029",
            "EN_HK",
            "EN_IN",
            "EN_MY",
            "EN_SG",
            "ES_419",
            "ES_US",
            "FF",
            "FF_LATN",
            "FF_LATN_SN",
            "FIL",
            "FIL_PH",
            "FR_CD",
            "FR_CI",
            "FR_CM",
            "FR_HT",
            "FR_MA",
            "FR_ML",
            "FR_RE",
            "FR_SN",
            "FY",
            "FY_NL",
            "GA",
            "GA_IE",
            "GD",
            "GD_GB",
            "GN",
            "GN_PY",
            "GSW",
            "GSW_FR",
            "HA",
            "HA_LATN",
            "HA_LATN_NG",
            "HAW",
            "HAW_US",
            "HSB",
            "HSB_DE",
            "IG",
            "IG_NG",
            "II",
            "II_CN",
            "IU",
            "IU_CANS",
            "IU_CANS_CA",
            "IU_LATN",
            "IU_LATN_CA",
            "JV",
            "JV_LATN",
            "JV_LATN_ID",
            "KL",
            "KL_GL",
            "KM",
            "KM_KH",
            "KU",
            "KU_ARAB",
            "KU_ARAB_IQ",
            "LB",
            "LB_LU",
            "LO",
            "LO_LA",
            "MG",
            "MG_MG",
            "ML",
            "ML_IN",
            "MN_CYRL",
            "MN_MONG",
            "MN_MONG_CN",
            "MN_MONG_MN",
            "MOH",
            "MOH_CA",
            "MY",
            "MY_MM",
            "NE",
            "NE_IN",
            "NE_NP",
            "NN",
            "NO",
            "NQO",
            "NQO_GN",
            "NSO",
            "NSO_ZA",
            "OC",
            "OC_FR",
            "OM",
            "OM_ET",
            "OR",
            "OR_IN",
            "PA_ARAB",
            "PA_ARAB_PK",
            "PRS",
            "PRS_AF",
            "PS_AF",
            "PT_AO",
            "QUT",
            "QUT_GT",
            "QUZ",
            "QUZ_BO",
            "QUZ_EC",
            "QUZ_PE",
            "RM",
            "RM_CH",
            "RO_MD",
            "RW",
            "RW_RW",
            "SAH",
            "SAH_RU",
            "SD",
            "SD_ARAB",
            "SD_ARAB_PK",
            "SI",
            "SI_LK",
            "SMA",
            "SMA_NO",
            "SMA_SE",
            "SMJ",
            "SMJ_NO",
            "SMJ_SE",
            "SMN",
            "SMN_FI",
            "SMS",
            "SMS_FI",
            "SN",
            "SN_LATN",
            "SN_LATN_ZW",
            "SO",
            "SO_SO",
            "SR",
            "SR_CYRL",
            "SR_CYRL_BA",
            "SR_CYRL_CS",
            "SR_CYRL_ME",
            "SR_CYRL_RS",
            "SR_LATN",
            "SR_LATN_BA",
            "SR_LATN_CS",
            "SR_LATN_ME",
            "SR_LATN_RS",
            "ST",
            "ST_ZA",
            "TA_LK",
            "TG",
            "TG_CYRL",
            "TG_CYRL_TJ",
            "TI",
            "TI_ER",
            "TI_ET",
            "TK",
            "TK_TM",
            "TN_BW",
            "TS_ZA",
            "TZM",
            "TZM_LATN",
            "TZM_LATN_DZ",
            "TZM_TFNG",
            "TZM_TFNG_MA",
            "UG",
            "UG_CN",
            "UR_IN",
            "UZ_CYRL",
            "UZ_CYRL_UZ",
            "UZ_LATN",
            "UZ_LATN_UZ",
            "WO",
            "WO_SN",
            "YO",
            "YO_NG",
            "ZGH",
            "ZGH_TFNG",
            "ZGH_TFNG_MA",
            "ZH_HANS",
            "ZH_HANT",
            "ZH_CHS",
            "ZH_CHT"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "LanguageCode",
            "modelAsString": false
          }
        }
      }
    },
    "EnvelopeGetLongLivedDisposableCertificateWarning": {
      "description": "A warning for a long lived disposable certificate.",
      "type": "object",
      "properties": {
        "RequestId": {
          "description": "The identifier of the request.",
          "type": "string"
        },
        "RemoteDeviceId": {
          "description": "The identifier of the remote device.",
          "type": "string"
        }
      }
    },
    "EnvelopeGetSendCopy": {
      "description": "An action to send a copy of the documents to the recipient.",
      "type": "object",
      "properties": {
        "ContactInformation": {
          "$ref": "#/$defs/EnvelopeGetContactInformation",
          "description": "The contact information of the recipient."
        },
        "CopyingGroup": {
          "format": "int32",
          "description": "The parallel group for copy actions.",
          "type": "integer"
        }
      }
    },
    "EnvelopeGetSenderUserInformation": {
      "description": "The information about the user who sent the envelope.",
      "type": "object",
      "properties": {
        "Email": {
          "description": "The email address of the sender.",
          "type": "string"
        },
        "GivenName": {
          "description": "The given name of the sender.",
          "type": "string"
        },
        "Surname": {
          "description": "The surname of the sender.",
          "type": "string"
        }
      }
    },
    "EnvelopeGetSign": {
      "description": "An action to sign documents.",
      "type": "object",
      "properties": {
        "ContactInformation": {
          "$ref": "#/$defs/EnvelopeGetContactInformation",
          "description": "The contact information of the recipient."
        },
        "LongLivedDisposableCertificateWarnings": {
          "description": "The warnings related to long lived disposable certificates.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/EnvelopeGetLongLivedDisposableCertificateWarning"
          }
        },
        "SigningGroup": {
          "format": "int32",
          "description": "The parallel group for sign actions.",
          "type": "integer"
        }
      }
    },
    "EnvelopeGetSignAsP7M": {
      "description": "An action to sign documents with P7M.",
      "type": "object",
      "properties": {
        "ContactInformation": {
          "$ref": "#/$defs/EnvelopeGetContactInformation",
          "description": "The contact information of the recipient."
        },
        "SignAsP7MGroup": {
          "format": "int32",
          "description": "The parallel group for P7M actions.",
          "type": "integer"
        }
      }
    },
    "EnvelopeGetSignAutomatic": {
      "description": "An automatic signing action.",
      "type": "object",
      "properties": {
        "ProfileId": {
          "description": "The identifier of the profile for the automatic signatures.",
          "type": "string"
        },
        "RenderingLanguageCode": {
          "description": "The rendering language for the automatic signatures.",
          "enum": [
            "AF",
            "AF_ZA",
            "AR",
            "AR_AE",
            "AR_BH",
            "AR_DZ",
            "AR_EG",
            "AR_IQ",
            "AR_JO",
            "AR_KW",
            "AR_LB",
            "AR_LY",
            "AR_MA",
            "AR_OM",
            "AR_QA",
            "AR_SA",
            "AR_SY",
            "AR_TN",
            "AR_YE",
            "AZ",
            "BE",
            "BE_BY",
            "BG",
            "BG_BG",
            "CA",
            "CA_ES",
            "CS",
            "CS_CZ",
            "CY",
            "CY_GB",
            "DA",
            "DA_DK",
            "DE",
            "DE_AT",
            "DE_CH",
            "DE_DE",
            "DE_LI",
            "DE_LU",
            "DV",
            "DV_MV",
            "EL",
            "EL_GR",
            "EN",
            "EN_AU",
            "EN_BZ",
            "EN_CA",
            "EN_GB",
            "EN_IE",
            "EN_JM",
            "EN_NZ",
            "EN_PH",
            "EN_TT",
            "EN_US",
            "EN_ZA",
            "EN_ZW",
            "ES",
            "ES_AR",
            "ES_BO",
            "ES_CL",
            "ES_CO",
            "ES_CR",
            "ES_DO",
            "ES_EC",
            "ES_ES",
            "ES_GT",
            "ES_HN",
            "ES_MX",
            "ES_NI",
            "ES_PA",
            "ES_PE",
            "ES_PR",
            "ES_PY",
            "ES_SV",
            "ES_UY",
            "ES_VE",
            "ET",
            "ET_EE",
            "EU",
            "EU_ES",
            "FA",
            "FA_IR",
            "FI",
            "FI_FI",
            "FO",
            "FO_FO",
            "FR",
            "FR_BE",
            "FR_CA",
            "FR_CH",
            "FR_FR",
            "FR_LU",
            "FR_MC",
            "GL",
            "GL_ES",
            "GU",
            "GU_IN",
            "HE",
            "HE_IL",
            "HI",
            "HI_IN",
            "HR",
            "HR_BA",
            "HR_HR",
            "HU",
            "HU_HU",
            "HY",
            "HY_AM",
            "ID",
            "ID_ID",
            "IS",
            "IS_IS",
            "IT",
            "IT_CH",
            "IT_IT",
            "JA",
            "JA_JP",
            "KA",
            "KA_GE",
            "KK",
            "KK_KZ",
            "KN",
            "KN_IN",
            "KO",
            "KO_KR",
            "KOK",
            "KOK_IN",
            "KY",
            "KY_KG",
            "LT",
            "LT_LT",
            "LV",
            "LV_LV",
            "MI",
            "MI_NZ",
            "MK",
            "MK_MK",
            "MN",
            "MN_MN",
            "MR",
            "MR_IN",
            "MS",
            "MS_BN",
            "MS_MY",
            "MT",
            "MT_MT",
            "NB",
            "NB_NO",
            "NL",
            "NL_BE",
            "NL_NL",
            "NN_NO",
            "PA",
            "PA_IN",
            "PL",
            "PL_PL",
            "PS",
            "PT",
            "PT_BR",
            "PT_PT",
            "RO",
            "RO_RO",
            "RU",
            "RU_RU",
            "SA",
            "SA_IN",
            "SE",
            "SE_FI",
            "SE_NO",
            "SE_SE",
            "SK",
            "SK_SK",
            "SL",
            "SL_SI",
            "SQ",
            "SQ_AL",
            "SV",
            "SV_FI",
            "SV_SE",
            "SW",
            "SW_KE",
            "SYR",
            "SYR_SY",
            "TA",
            "TA_IN",
            "TE",
            "TE_IN",
            "TH",
            "TH_TH",
            "TN",
            "TN_ZA",
            "TR",
            "TR_TR",
            "TT",
            "TT_RU",
            "TS",
            "UK",
            "UK_UA",
            "UR",
            "UR_PK",
            "UZ",
            "VI",
            "VI_VN",
            "XH",
            "XH_ZA",
            "ZH",
            "ZH_CN",
            "ZH_HK",
            "ZH_MO",
            "ZH_SG",
            "ZH_TW",
            "ZU",
            "ZU_ZA",
            "AM",
            "AM_ET",
            "ARN",
            "ARN_CL",
            "AS",
            "AS_IN",
            "AZ_CYRL",
            "AZ_CYRL_AZ",
            "AZ_LATN",
            "AZ_LATN_AZ",
            "BA",
            "BA_RU",
            "BN",
            "BN_BD",
            "BN_IN",
            "BO",
            "BO_CN",
            "BR",
            "BR_FR",
            "BS",
            "BS_CYRL",
            "BS_CYRL_BA",
            "BS_LATN",
            "BS_LATN_BA",
            "CA_ES_VALENCIA",
            "CHR",
            "CHR_CHER",
            "CHR_CHER_US",
            "CO",
            "CO_FR",
            "DSB",
            "DSB_DE",
            "EN_029",
            "EN_HK",
            "EN_IN",
            "EN_MY",
            "EN_SG",
            "ES_419",
            "ES_US",
            "FF",
            "FF_LATN",
            "FF_LATN_SN",
            "FIL",
            "FIL_PH",
            "FR_CD",
            "FR_CI",
            "FR_CM",
            "FR_HT",
            "FR_MA",
            "FR_ML",
            "FR_RE",
            "FR_SN",
            "FY",
            "FY_NL",
            "GA",
            "GA_IE",
            "GD",
            "GD_GB",
            "GN",
            "GN_PY",
            "GSW",
            "GSW_FR",
            "HA",
            "HA_LATN",
            "HA_LATN_NG",
            "HAW",
            "HAW_US",
            "HSB",
            "HSB_DE",
            "IG",
            "IG_NG",
            "II",
            "II_CN",
            "IU",
            "IU_CANS",
            "IU_CANS_CA",
            "IU_LATN",
            "IU_LATN_CA",
            "JV",
            "JV_LATN",
            "JV_LATN_ID",
            "KL",
            "KL_GL",
            "KM",
            "KM_KH",
            "KU",
            "KU_ARAB",
            "KU_ARAB_IQ",
            "LB",
            "LB_LU",
            "LO",
            "LO_LA",
            "MG",
            "MG_MG",
            "ML",
            "ML_IN",
            "MN_CYRL",
            "MN_MONG",
            "MN_MONG_CN",
            "MN_MONG_MN",
            "MOH",
            "MOH_CA",
            "MY",
            "MY_MM",
            "NE",
            "NE_IN",
            "NE_NP",
            "NN",
            "NO",
            "NQO",
            "NQO_GN",
            "NSO",
            "NSO_ZA",
            "OC",
            "OC_FR",
            "OM",
            "OM_ET",
            "OR",
            "OR_IN",
            "PA_ARAB",
            "PA_ARAB_PK",
            "PRS",
            "PRS_AF",
            "PS_AF",
            "PT_AO",
            "QUT",
            "QUT_GT",
            "QUZ",
            "QUZ_BO",
            "QUZ_EC",
            "QUZ_PE",
            "RM",
            "RM_CH",
            "RO_MD",
            "RW",
            "RW_RW",
            "SAH",
            "SAH_RU",
            "SD",
            "SD_ARAB",
            "SD_ARAB_PK",
            "SI",
            "SI_LK",
            "SMA",
            "SMA_NO",
            "SMA_SE",
            "SMJ",
            "SMJ_NO",
            "SMJ_SE",
            "SMN",
            "SMN_FI",
            "SMS",
            "SMS_FI",
            "SN",
            "SN_LATN",
            "SN_LATN_ZW",
            "SO",
            "SO_SO",
            "SR",
            "SR_CYRL",
            "SR_CYRL_BA",
            "SR_CYRL_CS",
            "SR_CYRL_ME",
            "SR_CYRL_RS",
            "SR_LATN",
            "SR_LATN_BA",
            "SR_LATN_CS",
            "SR_LATN_ME",
            "SR_LATN_RS",
            "ST",
            "ST_ZA",
            "TA_LK",
            "TG",
            "TG_CYRL",
            "TG_CYRL_TJ",
            "TI",
            "TI_ER",
            "TI_ET",
            "TK",
            "TK_TM",
            "TN_BW",
            "TS_ZA",
            "TZM",
            "TZM_LATN",
            "TZM_LATN_DZ",
            "TZM_TFNG",
            "TZM_TFNG_MA",
            "UG",
            "UG_CN",
            "UR_IN",
            "UZ_CYRL",
            "UZ_CYRL_UZ",
            "UZ_LATN",
            "UZ_LATN_UZ",
            "WO",
            "WO_SN",
            "YO",
            "YO_NG",
            "ZGH",
            "ZGH_TFNG",
            "ZGH_TFNG_MA",
            "ZH_HANS",
            "ZH_HANT",
            "ZH_CHS",
            "ZH_CHT"
          ],
          "type": "string"
        }
      }
    },
    "EnvelopeGetView": {
      "description": "An action to view and acknowledge the documents.",
      "type": "object",
      "properties": {
        "ContactInformation": {
          "$ref": "#/$defs/EnvelopeGetContactInformation",
          "description": "The contact information of the recipient."
        },
        "ViewingGroup": {
          "format": "int32",
          "description": "The parallel group for view actions.",
          "type": "integer"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/namirial-envelope-get-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.