• Test
      • Landing
    • Endpoints
      • Verifications
        • Create a verification
        • Get a verification
        • Delete a verification
        • Resend a verification
        • Reset a verification
        • Approve a verification check result
        • Approve Quick IDV result (deprecated)
        • Approve PEP result (deprecated)
        • Create and run a verification
        • Create and run a company verification
        • Approve FaceMatch result (deprecated)
      • Outsourced Verifications
        • Create an outsourced verification
        • Get an outsourced verification
        • Delete an outsourced verification
      • Risk Assessment
        • Create a risk rating
        • Get risk rating details
      • E-sign Templates
        • List e-sign templates
        • Fetch an e-sign template
      • E-sign Documents
        • List e-sign documents
        • Create an e-sign draft document
        • Fetch an e-sign document
        • Update an e-sign draft document
        • Delete an e-sign document
        • Duplicate an e-sign document
        • Create an e-sign iframe builder session
        • Send an e-sign document
        • Resend an e-sign document
        • Reinitiate an e-sign document
        • Void an e-sign document
      • Form Submissions
        • Create a form submission
        • Fetch a form submission
        • Delete a form submission
        • Resend a form submission
    • Schemas
      • VerificationRequest
      • VerificationCompanyRequest
      • VerificationSimple
      • Verification
      • VerificationCompany
      • OutsourcedVerificationRequest
      • OutsourcedVerificationSimple
      • OutsourcedVerification
      • OutsourcedVerificationType
      • OutsourcedVerificationStatus
      • OutsourcedVerificationResult
      • OutsourcedVerificationIndividual
      • VerificationType
      • VerificationResultSource
      • Result
      • PepResult
      • PepType
      • PepHit
      • DocumentOCRData
      • FaceMatchVoiResult
      • NationalIdTypes
      • BadRequest
      • Metadata
      • PersonName
      • PersonBirthDate
      • ContactMethods
      • AddressFields
      • GeoCoordinates
      • NationalIdBundle
      • VerificationAlgorithmSelection
      • VerificationIdentityResponse
      • VerificationCoreResponse
      • VerificationAddressResponse
      • VerificationNationalIdsResponse
      • VerificationMetadataResponse
      • OtherCountries
      • OutsourcedContactMethods
      • OutsourcedOrgTracking
      • OutsourcedCore
      • CompanyContactMethods
      • CompanyCore
      • CompanyTracking
      • VerificationResendRequest
      • RiskLevel
      • RiskAnswer
      • RiskSection
      • RiskQuestion
      • RiskRatingAnswer
      • RiskRating
      • RiskRatingCreateRequest
      • FormSubmissionCreateRequest
      • FormSubmission
      • FormSubmissionUser
      • FormSubmissionForm
      • FormSubmissionVerification
      • FormSubmissionValue
      • ESignTwoFactorMethod
      • ESignEnvelopeStatus
      • ESignRecipientStatus
      • ESignFieldType
      • ESignFieldDefaultValueMode
      • ESignTemplateRecipientRole
      • ESignTemplate
      • ESignDocumentRecipientOverride
      • ESignDocumentCreateRequest
      • ESignRecipientCreateRequest
      • ESignRecipientUpdateRequest
      • ESignDocumentFile
      • ESignField
      • ESignFieldGroup
      • ESignRecipient
      • ESignActionRequiredRecipient
      • ESignActionRequired
      • ESignDocument
      • ESignFieldResponse
      • ESignCompletionCertificate
      • ESignDocumentDetail
      • ESignSendDocumentResponse
      • ESignReinitiateDocumentResponse
      • ESignDocumentUpdateRequest
      • ESignDocumentDuplicateRequest
      • ESignDocumentPage
      • ESignIframeSessionCreateRequest
      • ESignIframeSessionResponse
      • ESignResendDocumentRequest
      • ESignResendDocumentResponse
      • ESignVoidDocumentRequest
      • ESignVoidDocumentResponse

    ESignRecipient

    Public recipient representation.

    {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
        "role_name": "string",
        "name": "string",
        "email": "user@example.com",
        "phone_number": "string",
        "require_2fa": true,
        "two_fa_method": "sms",
        "verification_type": "quick_id",
        "verification_status": "pending",
        "verification_result": "PASS",
        "verification_signature_key": "string",
        "redirect_url": "http://example.com",
        "has_signed": true,
        "signed_at": "2019-08-24T14:15:22.123Z",
        "notified_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z",
        "order": 1,
        "fields": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
                "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
                "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
                "field_type": "primary_contact_name",
                "page_number": 1,
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0,
                "label": "string",
                "required": true,
                "metadata": {
                    "property1": "string",
                    "property2": "string"
                },
                "default_value": {
                    "property1": "string",
                    "property2": "string"
                },
                "default_value_mode": "none",
                "show_on_pdf": true,
                "option_value": "string",
                "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
                "group_name": "string",
                "min_selections": 0,
                "max_selections": 0
            }
        ],
        "field_groups": [
            {
                "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
                "name": "string",
                "field_type": "primary_contact_name",
                "min_selections": 0,
                "max_selections": 0,
                "fields": [
                    {
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "envelope": "9aca662d-6a05-4586-b61d-f02733be3287",
                        "recipient": "31d78262-cbd4-4f35-8070-a83c4bfe5327",
                        "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
                        "field_type": "primary_contact_name",
                        "page_number": 1,
                        "x": 0,
                        "y": 0,
                        "width": 0,
                        "height": 0,
                        "label": "string",
                        "required": true,
                        "metadata": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "default_value": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "default_value_mode": "none",
                        "show_on_pdf": true,
                        "option_value": "string",
                        "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
                        "group_name": "string",
                        "min_selections": 0,
                        "max_selections": 0
                    }
                ]
            }
        ],
        "status": "waiting",
        "is_self_sign": true
    }
    Built with