Skip to content

Considerations

The API is based in Lucene, and every detail can be consulted in the Elasticsearch API. Please note that our Elasticsearch is working on a fork out of the 7.10 version, so we recommend to search for this version documentation to have full compatibility.

access fields list

Field Description
client_ip Source IP address from the client calling to VeriSaaS
cloud_account_id Cloud Account identifier
latencies.request Time passed between the start of the request and the end of the response
request.headers.accept-charset The Accept-Charset request HTTP header was a header that advertised a client's supported character encodings.
request.headers.accept-encoding The Accept-Encoding request HTTP header indicates the content encoding (usually a compression algorithm) that the client can understand.
request.headers.accept-language The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.
request.headers.accept The Accept request HTTP header indicates which content types, expressed as MIME types, the client is able to understand.
request.headers.connection The Connection general header controls whether the network connection stays open after the current transaction finishes. (keep-alive)
request.headers.content-length The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.
request.headers.content-type The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).
request.headers.host The Host request header specifies the host and port number of the server to which the request is being sent.
request.headers.origin The Origin request header indicates the origin (scheme, hostname, and port) that caused the request.
request.headers.referer The Referer HTTP request header contains an absolute or partial address of the page that makes the request.
request.headers.sec-fetch-dest The Sec-Fetch-Dest fetch metadata request header indicates the request's destination.
request.headers.sec-fetch-mode The Sec-Fetch-Mode fetch metadata request header indicates the mode of the request. (cors, websocket...)
request.headers.sec-fetch-site The Sec-Fetch-Site fetch metadata request header indicates the relationship between a request initiator's origin and the origin of the requested resource.
request.headers.transfer-encoding The Transfer-Encoding header specifies the form of encoding used to safely transfer the payload body to the user.
request.headers.user-agent The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
request.headers.x-forwarded-port Request destination port
request.headers.x-forwarded-proto Request protocol (HTTP, HTTPS)
request.method HTTP request method (GET, POST, PUT, etc.)
request.size Size of the request (in bytes)
request.tls.cipher TLS cipher suite used by the client
request.tls.version TLS version used by the client
request.uri Request URI (endpoint)
response.headers.accept-ranges The Accept-Ranges HTTP response header is a marker used by the server to advertise its support for partial requests from the client for file downloads. The value of this field indicates the unit that can be used to define a range.
response.headers.cache-control The Cache-Control HTTP header field holds directives (instructions) that control caching in browsers and shared caches.
response.headers.connection The Connection general header controls whether the network connection stays open after the current transaction finishes. (keep-alive)
response.headers.content-disposition In a regular HTTP response, the Content-Disposition response header is a header indicating if the content is expected to be displayed inline in the browser or as an attachment.
response.headers.content-length The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.
response.headers.content-type The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).
response.headers.date The Date general HTTP header contains the date and time at which the message originated.
response.headers.etag The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.
response.headers.expires The Expires HTTP header contains the date/time after which the response is considered expired.
response.headers.last-modified The Last-Modified response HTTP header contains a date and time when the origin server believes the resource was last modified.
response.headers.www-authenticate The HTTP WWW-Authenticate response header defines the HTTP authentication methods ("challenges") that might be used to gain access to a specific resource.
response.headers.x-throttling-delay Time shift added by the request throttling plugin
response.size Size of the response (in bytes)
response.status HTTP response status
started_at Timestamp of the first bit arrival

summary fields list

Field Type Description Possible Values
validation_id string ID of the validation
state string Validation status at the time of deletion confirm, cancel
document_type string Document Type Please refer to document coverage
service_mode string Service mode, ocr, validation or validation_with_flash ocr, validation, validation_with_flash
document_images.obverse string The obverse image exists and was correctly processed "true"
document_images.obverseFlash string The obverse with flash image exists and was correctly processed "true"
document_images.reverse string The reverse image exists and was correctly processed "true"
document_images.nfcFace string The Face image in the NFC exists and was correctly processed "true"
biometry_images.selfie string The selfie image exists and was correctly processed "true"
biometry_images.video string The videoselfie image exists and was correctly processed "true"
biometry_images.challengeVideo string The challenge video exists and was correctly processed "true"
biometry_images.videoAnnotations string The video annotations exist and were correctly processed "true"
contextual_data object Validation contextual data Validation contextual data. if they have the prefix "stats" they are logged in
environment.user-agent string Custom fields with the string sent by the browser in the User-Agent header
environment.class string Platform Information web-desktop, web-mobile, native-ios or native-android
environment.platform string Platform Android/iOS
environment.sdk_information array List with the names and versions of the SDK's sdk-document-capture, sdk-photo-selfie-capture, sdk-selfie-alive-capture, sdk-video-selfie-capture, sdk-nfc y sus versiones
evidences_timestamp.createdAt date Creation date
evidences_timestamp.timestampAuthority string Authority with which the time stamp is made
identity_verification.scores array Identity verification scores 1 OK, 0 KO
funnel.start_date string Start date of the onboarding process
funnel.end_date string End date of the onboarding process
document_scores.Score-DocumentGlobal number Document global score
biometry_scores.ValidasScoreSelfie number Selfie comparation with document photo score
biometry_scores.ValidasScoreVideo number Video validation score
biometry_scores.ValidasScoreDuplicateAttack number Score duplicate attack
biometry_scores.ValidasScorePhotoId number Score photo id
biometry_scores.ValidasScoreLifeProof number Score proof of life
biometry_scores.ValidasScoreNfcSelfie number Score selfie comparation with NFC face
biometry_scores.ValidasScoreNfcPhotoId number Score document photo comparation with NFC face
biometry_scores.ValidasScoreSelfieAuthenticity number Selfie authenticity score
integrity_scores.ValidasScoreIntegrity number Validation integrity score
summary_scores.ValidationGlobalScore number Global validation score

Service restrictions

  • There is not a commited SLA for this service at the moment
  • Veridas reserves the right of blocking this service in case of a threatful or improper use of it
  • The logs have a persistance of one year
  • Veridas controls the user management of this service
  • This service may imply additional costs. Should you be interested, please contact your Veridas Sales rep