Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Response data

Response data structure produced by Landing

Callback structure

Below is a detailed description of the data structure used in our system and the specific details of each data field, including its type, purpose, and constraints.

Morphology:

{
  "transactionId": "TRANSACTION_ID",
  "dni": "DOCUMENT_NUMBER",
  "clientData": "CLIENT_DATA",
  "deviceInfo": "DEVICE_INFO",
  "lastStep": {
    "stepId": "STEP_ID",
    "stepType": "STEP_TYPE",
    "timestamp": "UNIX_TIMESTAMP",
    "widget": "WIDGET_NAME"
  },
  "resultJSON": {
    "DocumentData": {
      "serviceTransactionId": "TRANSACTION_ID",
      "serviceDocument": {
        "DOC_MODEL": "DOCUMENT_MODEL",
        "BACKSIDE": "DOCUMENT_BACKSIDE",
        "FRONTSIDE": "DOCUMENT_FRONTSIDE",
        "DECOMPOSED": "DOCUMENT_DECOMPOSE",
        "CHECKS": "DOCUMENT_CHECKS",
        "SCORING": "DOCUMENT_SCORING",
      }
    },
    "DocumentValidation": "DOCUMENT_VALIDATION",
    "imageFront": "FRONT_BASE64_IMAGE",
    "imageBack": "BACK_BASE64_IMAGE",
    "FacialAuthentication": "AUTHENTICATION_DATA",
    "PassiveLiveness": "PASSIVE_LIVENESS_DATA",
    "imageSelfie": "SELFIE_BASE64_IMAGE",
    "imageFrontRaw": "/9j/4AAQSkZJRgAB...",
    "imageBackRaw": "/9j/4AAQSkZJRgAB...",
    "rawTemplateSelfie": "BAEBAQJi/8ZtRtF/UV+p4Ued+Z...",
    "rawTemplateFacialCapture": "BAEBAQJQ/8ZtRtF/UV+p4Ued+Z..."
  }
}

Example:

Parameter list

This is a collection of examples of the data that is sent:

TRANSACTION_ID

Unique transaction ID.

Details:

  • Can it be empty?: No.

Example:

DOCUMENT_NUMBER

Stores the document number associated with a customer.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no document number; this may be because the service could not extract the document number or there was a problem during the data extraction process.

Example:

CLIENT_DATA

Stores information about a customer who has completed the onboarding process.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no customer data; this may be because a session has not been started or there was a problem during the session process.

Morphology:

Example:

Field reference:

CUSTOMER_ID

This identifier is used to distinguish each user in the system. This identifier may be provided by the contracting company or generated internally.

Example:

DEVICE_INFO

Stores information about the device used by the customer during the onboarding process.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no device information; this may be because device information was not sent or there was a problem during the event process.

Morphology:

Example:

Field references:

OS_NAME

Stores information about the operating system name.

Example:

OS_VERSION

Stores information about the operating system Version.

Example:

DEVICE_MODEL

Stores information about the device model.

Example:

DEVICE_BRAND

Stores information about the device brand.

Example:

DEVICE_BROWSER

Stores information about the device browser.

Example:

LAST_STEP

Stores information about the last step/stage completed by the customer during the onboarding process.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no information about the completed step; this may be because the customer has not yet started the flow or there was a problem during event capture.

Morphology:

Fields:

  • stepId (string): Unique identifier of the completed step.

  • stepType (string): Type or category of the step (e.g.: "VERIFICATION", "CAPTURE", "CONFIRMATION").

  • timestamp (number): Unix timestamp of the moment the step was completed.

  • widget (string): Name of the component or widget that executed the step (e.g.: "BiometricCapture", "TermsAcceptance").

Example:

DOCUMENT_MODEL

Stores the model or type of document.

Details:

  • Can it be empty?: Yes.

  • Reason: No document model was detected; this may be because the service could not detect the document model or there was a problem during the data extraction process.

Example:

DOCUMENT_BACKSIDE

Stores the specific information and details related to the back side or rear side of a document.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no image of the back side of the document; this may be because it is a Passport, the ID does not require a document image, the image was not sent, or there was a problem during the data extraction process.

Example:

DOCUMENT_FRONTSIDE

Stores the specific information and details related to the front side of a document.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no image of the front side of the document; this may be because the ID does not require a document image, the image was not sent, or there was a problem during the data extraction process.

Example:

DOCUMENT_DECOMPOSE

Stores fragments or crops of the document images.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no device information; this may be because device information was not sent or there was a problem during the event process.

Morphology:

Example:

Field references:

DOCUMENT_PORTRAIT_BASE64_IMAGE

Stores the crop or fragment of the document photo that shows only the user's face.

Example:

DOCUMENT_CHECKS

Stores a collection of fields from the steps that have been verified or checked during the data extraction process.

Details:

  • Can it be empty?: Yes.

  • Reason: There are no data checks; this may be because the service does not generate data checks or there was a problem during the data extraction process.

Example:

DOCUMENT_SCORING

Stores a collection of scores that assess the reliability of the data extracted from a document.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no scoring data; this may be because the service does not generate scoring data or there was a problem during the data extraction process.

Example:

DOCUMENT_VALIDATION

Stores information related to document validation.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no document validation data; this may be because the service is not enabled or there was a problem during the document validation process.

Morphology:

Example:

Field references:

DOCUMENT_VALIDATION_REFERENCE

Stores information related to the document validation reference.

Example:

DOCUMENT_VALIDATION_TYPE

Stores information related to the document validation status.

Example:

DOCUMENT_VALIDATION_TIME

Stores information related to the document validation date.

Example:

FRONT_BASE64_IMAGE

Stores the image of the front side of a document.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no image of the front side of the document; this may be because the image was not sent or there was a problem during saving.

Example:

BACK_BASE64_IMAGE

Stores the image of the back side of a document.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no image of the back side of the document; this may be because the image was not sent or there was a problem during saving.

Example:

AUTHENTICATION_DATA

Stores information related to the person's authentication.

Details:

  • Can it be empty?: Yes.

  • Reason: There are no facial authentication data; this may be because there was a problem during the facial authentication process.

Morphology:

Example:

Field references:

AUTHENTICATION_STATUS

Stores the authentication status.

Example:

AUTHENTICATION_SIMILARITY

Stores the similarity measure or matching level obtained during the authentication process of a person.

Example:

PASSIVE_LIVENESS_DATA

Stores information related to the person's passive liveness check.

Details:

  • Can it be empty?: Yes.

  • Reason: There are no passive liveness check data; this may be because there was a problem during the passive liveness check process.

Morphology:

Example:

Field references:

PASSIVE_LIVENESS_RESULT

Stores the result of the passive liveness check.

Example:

SELFIE_BASE64_IMAGE

Stores the selfie image of a person.

Details:

  • Can it be empty?: Yes.

  • Reason: There is no selfie image; this may be because the image was not sent or there was a problem during saving.

Example:

FRONT_RAW_BASE64_IMAGE

Stores the full frame of the front side of the document in base64 format.

Details:

  • Can it be empty?: Yes.

  • Reason: The front side image of the document may not have been sent, or there was a problem during the extraction process.

Example:

BACK_RAW_BASE64_IMAGE

Stores the full frame of the back side of the document in base64 format.

Details:

  • Can it be empty?: Yes.

  • Reason: The back side image of the document may not have been sent, or there was a problem during the extraction process.

Example:

RAW_TEMPLATE_SELFIE (templateRaw)

Stores the raw Biometric Template of the selfie (templateRaw) in base64 format.

Details:

  • Can it be empty?: Yes.

  • Reason: The selfie template may not have been sent, or there was a problem during the biometric extraction process.

Example:

RAW_TEMPLATE_FACIAL_CAPTURE

Stores the raw template of the document Face Capture (rawTemplateFacialCapture) in base64 format.

Details:

  • Can it be empty?: Yes.

  • Reason: The Face Capture template may not have been sent, or there was a problem during the biometric extraction process.

Example:

Callback example

Successful Callback Response

This use case describes the scenario in which a customer successfully completes the onboarding process on a platform or service.

Empty Callback Response

This use case addresses the scenario in which all possible options or alternatives have no content or are empty:

PreviousBasic implementationNextOperations query

Last updated