Realaml API
Basic Realaml workflow
Mock/Test Requests (Staging)
Security recommendations
iFrame Embed
iOS SDK
Android SDK
API Reference
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
Create an e-sign draft document
Fetch an e-sign document
List e-sign documents
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
National IDs
Australia (AU)
Canada (CA)
China (CN)
Denmark (DK)
India (IN)
Mexico (MX)
New Zealand (NZ)
United States (US)
South Africa (ZA)
Changelog
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
Security recommendations
Follow these recommendations to keep your Realaml integration secure.
Protect your API keys
#
Do not expose API keys publicly.
This includes client-side code such as:
Web frontends
Mobile apps
Public websites
API keys should be used
only
in your
backend
systems.
Data retention and access
#
Verifications are stored in the Realaml system for
10 years
by default.
Access to verification data is generally restricted after
14 days
.
Deleting verifications earlier
#
If you want completed or incomplete verifications deleted sooner, contact the Realaml team.
Before requesting deletion:
Ensure you have stored any results and PDFs you need in your own systems.
Once a verification is deleted, you are responsible for retaining copies for future reference.
Previous
Mock/Test Requests (Staging)
Next
iFrame Embed