# Realaml ## Docs - Test [Landing](https://developers.realaml.com/landing-2181466m0.md): ## API Docs - Endpoints > Verifications [Create a verification](https://developers.realaml.com/create-a-verification-36861905e0.md): Create a new verification and return a signature key and URL. - Endpoints > Verifications [Get a verification](https://developers.realaml.com/get-a-verification-36861906e0.md): Fetch full verification details by `signature_key`. - Endpoints > Verifications [Delete a verification](https://developers.realaml.com/delete-a-verification-36861907e0.md): Delete a verification by `signature_key`. - Endpoints > Verifications [Resend a verification](https://developers.realaml.com/resend-a-verification-36861908e0.md): Resend a verification invite. You may update contact details. If any update fields are provided after at least one check has completed, the request returns 400 with "Verification is not in valid state." Resend without updates is still allowed. - Endpoints > Verifications [Reset a verification](https://developers.realaml.com/reset-a-verification-36861909e0.md): Reset a verification to allow the end-user to restart the flow. - Endpoints > Verifications [Approve a verification check result](https://developers.realaml.com/approve-a-verification-check-result-36861910e0.md): Approve one check (or all checks) for a verification, optionally replacing the existing notes. - Endpoints > Verifications [Approve Quick IDV result (deprecated)](https://developers.realaml.com/approve-quick-idv-result-deprecated-36861911e0.md): Approve Quick IDV Result - Endpoints > Verifications [Approve PEP result (deprecated)](https://developers.realaml.com/approve-pep-result-deprecated-36861912e0.md): Approve PEP check Result - Endpoints > Verifications [Create and run a verification](https://developers.realaml.com/create-and-run-a-verification-36861913e0.md): Create a new verification, run it immediately, and return the full result. - Endpoints > Verifications [Create and run a company verification](https://developers.realaml.com/create-and-run-a-company-verification-36861914e0.md): Create a new company verification, run it immediately, and return the full result. - Endpoints > Verifications [Approve FaceMatch result (deprecated)](https://developers.realaml.com/approve-facematch-result-deprecated-36861915e0.md): Approve FaceMatch Result - Endpoints > Outsourced Verifications [Create an outsourced verification](https://developers.realaml.com/create-an-outsourced-verification-36861916e0.md): Create a new outsourced verification. - Endpoints > Outsourced Verifications [Get an outsourced verification](https://developers.realaml.com/get-an-outsourced-verification-36861917e0.md): Fetch outsourced verification details by `signature_key`. - Endpoints > Outsourced Verifications [Delete an outsourced verification](https://developers.realaml.com/delete-an-outsourced-verification-36861918e0.md): Delete an outsourced verification by `signature_key`. - Endpoints > Risk Assessment [Create a risk rating](https://developers.realaml.com/create-a-risk-rating-36861923e0.md): Create a new risk rating for a verification. - Endpoints > Risk Assessment [Get risk rating details](https://developers.realaml.com/get-risk-rating-details-36861924e0.md): Fetch risk rating details by `risk_assessment_id` for a verification. - Endpoints > E-sign Templates [List e-sign templates](https://developers.realaml.com/list-e-sign-templates-36861925e0.md): List agency e-sign templates available to the API key user. The response includes template metadata and `recipient_roles`; it intentionally does not include template files, PDF field coordinates, or global templates. Use `recipient_roles[].id` as `template_role_id` when creating a document from a template with recipient overrides. Query parameters such as `source=all` are not supported on this public OpenAPI endpoint. - Endpoints > E-sign Templates [Fetch an e-sign template](https://developers.realaml.com/fetch-an-e-sign-template-36861926e0.md): Fetch one agency e-sign template available to the API key user. The response includes template metadata and recipient roles only; template files and field coordinates stay private to the dashboard/editor flow. Use the returned `recipient_roles[].id` values as `template_role_id` values when creating a document from this template. - Endpoints > E-sign Documents [List e-sign documents](https://developers.realaml.com/list-e-sign-documents-36861927e0.md): List e-sign documents visible to the API key user. When `page` or `page_size` is supplied, the response is paginated; otherwise the response is a direct array. Use `status` and `search` to narrow results. - Endpoints > E-sign Documents [Create an e-sign draft document](https://developers.realaml.com/create-an-e-sign-draft-document-36861928e0.md): Create a draft e-sign document. There are two creation paths. To create from scratch, omit `template_id`; the API creates an empty draft and the iframe builder is used to upload files, manage recipients, place PDF fields, and send. To create from a template, provide `template_id`; RealAML copies template files, recipient roles, and PDF fields into a new draft. Optional `recipients` entries are recipient overrides and must map to template roles with `template_role_id`. Creation never sends automatically; call `POST /documents/{envelope_id}/send/` or send from the iframe builder when the draft is ready. - Endpoints > E-sign Documents [Fetch an e-sign document](https://developers.realaml.com/fetch-an-e-sign-document-36861929e0.md): Fetch full e-sign document details, including files, recipients, field responses, final PDF URL, and completion certificate where available. Final PDF and certificate signed URLs are temporary. Use this endpoint after sending, webhooks, callbacks, or iframe events to inspect the latest document state. - Endpoints > E-sign Documents [Update an e-sign draft document](https://developers.realaml.com/update-an-e-sign-draft-document-36861930e0.md): Update editable metadata on a draft e-sign document, such as title, email copy, completion message, expiry, expiry alert, CC emails, and self-sign settings. Sent or terminal documents cannot be modified through this endpoint. - Endpoints > E-sign Documents [Delete an e-sign document](https://developers.realaml.com/delete-an-e-sign-document-36861931e0.md): Soft-delete/archive an e-sign document from the API user scope. This removes it from normal API listing without exposing a hard-delete operation. - Endpoints > E-sign Documents [Duplicate an e-sign document](https://developers.realaml.com/duplicate-an-e-sign-document-36861932e0.md): Create a new draft copy of an existing e-sign document. The duplicate includes files, recipients, fields, routing, and editable email settings, but does not copy signing responses, completion artifacts, or terminal status. The duplicate remains draft until sent. - Endpoints > E-sign Documents [Create an e-sign iframe builder session](https://developers.realaml.com/create-an-e-sign-iframe-builder-session-36861933e0.md): Create a strong one-off iframe builder session for a draft e-sign document. The request body is empty. The response returns `iframe_url`, `session_key`, `iframe_session_id`, `document_id`, and `expires_at`; this iframe-session creation response does not expose the agency iframe allowlist, brand payload, `allowed_origin`, or `redirect_url`. - Endpoints > E-sign Documents [Send an e-sign document](https://developers.realaml.com/send-an-e-sign-document-36861934e0.md): Send a draft e-sign document to its first signing step. Create-from-template does not auto-send; call this endpoint after the draft is ready. Before sending, RealAML validates that the document has a title, at least one file, at least one recipient, recipient email addresses, valid 2FA settings, PDF fields, and required signature fields. On success, the document status changes to sent and recipient notification/PDF preparation processing starts. - Endpoints > E-sign Documents [Resend an e-sign document](https://developers.realaml.com/resend-an-e-sign-document-36861935e0.md): Resend a signing request for a sent or processing document. Provide `recipient_id` to resend to a specific eligible recipient, or omit it to resend the active signing step. Resend rate limits apply. - Endpoints > E-sign Documents [Reinitiate an e-sign document](https://developers.realaml.com/reinitiate-an-e-sign-document-36861936e0.md): Restore an eligible document to draft so it can be edited and sent again. This is used for documents in failed, declined, expired, voided, or authentication-failed states where a fresh draft workflow is needed. - Endpoints > E-sign Documents [Void an e-sign document](https://developers.realaml.com/void-an-e-sign-document-36861937e0.md): Void a non-draft, non-completed, non-voided e-sign document. Voiding stops the active signing process and records the optional void reason. - Endpoints > Form Submissions [Create a form submission](https://developers.realaml.com/create-a-form-submission-36861919e0.md): Create a form submission for a given form. - Endpoints > Form Submissions [Fetch a form submission](https://developers.realaml.com/fetch-a-form-submission-36861920e0.md): Fetch a form submission by `form_submission_id`. - Endpoints > Form Submissions [Delete a form submission](https://developers.realaml.com/delete-a-form-submission-36861921e0.md): Delete a form submission by `form_submission_id`. - Endpoints > Form Submissions [Resend a form submission](https://developers.realaml.com/resend-a-form-submission-36861922e0.md): Resend a form submission invite. ## Schemas - [VerificationRequest](https://developers.realaml.com/verificationrequest-15362743d0.md): - [VerificationCompanyRequest](https://developers.realaml.com/verificationcompanyrequest-15362744d0.md): - [VerificationSimple](https://developers.realaml.com/verificationsimple-15362745d0.md): - [Verification](https://developers.realaml.com/verification-15362746d0.md): - [VerificationCompany](https://developers.realaml.com/verificationcompany-15362747d0.md): - [OutsourcedVerificationRequest](https://developers.realaml.com/outsourcedverificationrequest-15362748d0.md): - [OutsourcedVerificationSimple](https://developers.realaml.com/outsourcedverificationsimple-15362749d0.md): - [OutsourcedVerification](https://developers.realaml.com/outsourcedverification-15362750d0.md): - [OutsourcedVerificationType](https://developers.realaml.com/outsourcedverificationtype-15362751d0.md): - [OutsourcedVerificationStatus](https://developers.realaml.com/outsourcedverificationstatus-15362752d0.md): - [OutsourcedVerificationResult](https://developers.realaml.com/outsourcedverificationresult-15362753d0.md): - [OutsourcedVerificationIndividual](https://developers.realaml.com/outsourcedverificationindividual-15362754d0.md): - [VerificationType](https://developers.realaml.com/verificationtype-15362755d0.md): - [VerificationResultSource](https://developers.realaml.com/verificationresultsource-15362756d0.md): - [Result](https://developers.realaml.com/result-15362757d0.md): - [PepResult](https://developers.realaml.com/pepresult-15362758d0.md): - [PepType](https://developers.realaml.com/peptype-15362759d0.md): - [PepHit](https://developers.realaml.com/pephit-15362760d0.md): - [DocumentOCRData](https://developers.realaml.com/documentocrdata-15362761d0.md): - [FaceMatchVoiResult](https://developers.realaml.com/facematchvoiresult-15362762d0.md): - [NationalIdTypes](https://developers.realaml.com/nationalidtypes-15362763d0.md): - [BadRequest](https://developers.realaml.com/badrequest-15362764d0.md): - [Metadata](https://developers.realaml.com/metadata-15362765d0.md): - [PersonName](https://developers.realaml.com/personname-15362766d0.md): - [PersonBirthDate](https://developers.realaml.com/personbirthdate-15362767d0.md): - [ContactMethods](https://developers.realaml.com/contactmethods-15362768d0.md): - [AddressFields](https://developers.realaml.com/addressfields-15362769d0.md): - [GeoCoordinates](https://developers.realaml.com/geocoordinates-15362770d0.md): - [NationalIdBundle](https://developers.realaml.com/nationalidbundle-15362771d0.md): - [VerificationAlgorithmSelection](https://developers.realaml.com/verificationalgorithmselection-15362772d0.md): - [VerificationIdentityResponse](https://developers.realaml.com/verificationidentityresponse-15362773d0.md): - [VerificationCoreResponse](https://developers.realaml.com/verificationcoreresponse-15362774d0.md): - [VerificationAddressResponse](https://developers.realaml.com/verificationaddressresponse-15362775d0.md): - [VerificationNationalIdsResponse](https://developers.realaml.com/verificationnationalidsresponse-15362776d0.md): - [VerificationMetadataResponse](https://developers.realaml.com/verificationmetadataresponse-15362777d0.md): - [OtherCountries](https://developers.realaml.com/othercountries-15362778d0.md): - [OutsourcedContactMethods](https://developers.realaml.com/outsourcedcontactmethods-15362779d0.md): - [OutsourcedOrgTracking](https://developers.realaml.com/outsourcedorgtracking-15362780d0.md): - [OutsourcedCore](https://developers.realaml.com/outsourcedcore-15362781d0.md): - [CompanyContactMethods](https://developers.realaml.com/companycontactmethods-15362782d0.md): - [CompanyCore](https://developers.realaml.com/companycore-15362783d0.md): - [CompanyTracking](https://developers.realaml.com/companytracking-15362784d0.md): - [VerificationResendRequest](https://developers.realaml.com/verificationresendrequest-15362785d0.md): - [RiskLevel](https://developers.realaml.com/risklevel-15362786d0.md): - [RiskAnswer](https://developers.realaml.com/riskanswer-15362787d0.md): - [RiskSection](https://developers.realaml.com/risksection-15362788d0.md): - [RiskQuestion](https://developers.realaml.com/riskquestion-15362789d0.md): - [RiskRatingAnswer](https://developers.realaml.com/riskratinganswer-15362790d0.md): - [RiskRating](https://developers.realaml.com/riskrating-15362791d0.md): - [RiskRatingCreateRequest](https://developers.realaml.com/riskratingcreaterequest-15362792d0.md): - [FormSubmissionCreateRequest](https://developers.realaml.com/formsubmissioncreaterequest-15362793d0.md): - [FormSubmission](https://developers.realaml.com/formsubmission-15362794d0.md): - [FormSubmissionUser](https://developers.realaml.com/formsubmissionuser-15362795d0.md): - [FormSubmissionForm](https://developers.realaml.com/formsubmissionform-15362796d0.md): - [FormSubmissionVerification](https://developers.realaml.com/formsubmissionverification-15362797d0.md): - [FormSubmissionValue](https://developers.realaml.com/formsubmissionvalue-15362798d0.md): - [ESignTwoFactorMethod](https://developers.realaml.com/esigntwofactormethod-15362799d0.md): - [ESignEnvelopeStatus](https://developers.realaml.com/esignenvelopestatus-15362800d0.md): - [ESignRecipientStatus](https://developers.realaml.com/esignrecipientstatus-15362801d0.md): - [ESignFieldType](https://developers.realaml.com/esignfieldtype-15362802d0.md): - [ESignFieldDefaultValueMode](https://developers.realaml.com/esignfielddefaultvaluemode-15362803d0.md): - [ESignTemplateRecipientRole](https://developers.realaml.com/esigntemplaterecipientrole-15362804d0.md): - [ESignTemplate](https://developers.realaml.com/esigntemplate-15362805d0.md): - [ESignDocumentRecipientOverride](https://developers.realaml.com/esigndocumentrecipientoverride-15362806d0.md): - [ESignDocumentCreateRequest](https://developers.realaml.com/esigndocumentcreaterequest-15362807d0.md): - [ESignRecipientCreateRequest](https://developers.realaml.com/esignrecipientcreaterequest-15362808d0.md): - [ESignRecipientUpdateRequest](https://developers.realaml.com/esignrecipientupdaterequest-15362809d0.md): - [ESignDocumentFile](https://developers.realaml.com/esigndocumentfile-15362810d0.md): - [ESignField](https://developers.realaml.com/esignfield-15362811d0.md): - [ESignFieldGroup](https://developers.realaml.com/esignfieldgroup-15362812d0.md): - [ESignRecipient](https://developers.realaml.com/esignrecipient-15362813d0.md): - [ESignActionRequiredRecipient](https://developers.realaml.com/esignactionrequiredrecipient-15362814d0.md): - [ESignActionRequired](https://developers.realaml.com/esignactionrequired-15362815d0.md): - [ESignDocument](https://developers.realaml.com/esigndocument-15362816d0.md): - [ESignFieldResponse](https://developers.realaml.com/esignfieldresponse-15362817d0.md): - [ESignCompletionCertificate](https://developers.realaml.com/esigncompletioncertificate-15362818d0.md): - [ESignDocumentDetail](https://developers.realaml.com/esigndocumentdetail-15362819d0.md): - [ESignSendDocumentResponse](https://developers.realaml.com/esignsenddocumentresponse-15362820d0.md): - [ESignReinitiateDocumentResponse](https://developers.realaml.com/esignreinitiatedocumentresponse-15362821d0.md): - [ESignDocumentUpdateRequest](https://developers.realaml.com/esigndocumentupdaterequest-15362822d0.md): - [ESignDocumentDuplicateRequest](https://developers.realaml.com/esigndocumentduplicaterequest-15362823d0.md): - [ESignDocumentPage](https://developers.realaml.com/esigndocumentpage-15362824d0.md): - [ESignIframeSessionCreateRequest](https://developers.realaml.com/esigniframesessioncreaterequest-15362825d0.md): - [ESignIframeSessionResponse](https://developers.realaml.com/esigniframesessionresponse-15362826d0.md): - [ESignResendDocumentRequest](https://developers.realaml.com/esignresenddocumentrequest-15362827d0.md): - [ESignResendDocumentResponse](https://developers.realaml.com/esignresenddocumentresponse-15362828d0.md): - [ESignVoidDocumentRequest](https://developers.realaml.com/esignvoiddocumentrequest-15362829d0.md): - [ESignVoidDocumentResponse](https://developers.realaml.com/esignvoiddocumentresponse-15362830d0.md):