Authorization

/auth

Endpoint:

POST {url}/auth

Headers:

Content-Type: application/json

Request body examples:

Basic

{
    "apiKey": "API_KEY",
    "pwcs_version": 2,
    "profile_config": "UUID",
    "shortUrlPwcs": 1
}

Advanced (custom configuration)

{
    "apiKey": "API_KEY",
    "pwcs_version": 2,
    "token_exp": 1234567,
    "shortUrlPwcs": 1,
    "config": {
        "configuration": {
            "kyc": {
                "IdentityAntiFraud": {
                    "individual_configuration": {
                        "error_manipulated_photo": {
                            "blocking_step": true,
                            "identifier_block": false,
                            "ip_block": false
                        },
                        "error_photocopy": {
                            "blocking_step": true
                        },
                        "error_screen_photo": {
                            "blocking_step": true
                        }
                    }
                },
                "methods": {
                    "ReadMrz": true,
                    "VerifyData": true,
                    "Images": true,
                    "Liveness": true,
                    "FaceMatch": true,
                    "FacialRecognition": true,
                    "Selfie": false,
                    "FraudScoring": true,
                    "ImagesUrl": false,
                    "StorageUpload": true,
                    "Otp": true,
                    "Location": true,
                    "CheckFacesNumber": true
                },
                "fraudScoring": {
                    "aeat": "optional",
                    "expirationDate": true,
                    "legalAge": 18,
                    "photocopyCheck": false,
                    "hologramCheck": false
                }
            },
            "front": {
                "ideal": {
                    "width": 650
                },
                "skin": "dark",
                "kyc_mode": "auto",
                "new_index": true,
                "liveness_config": {},
                "title_kyc": "KYC",
                "wait_after_kyc_success": true,
                "max_dni_width": 800,
                "liveness_guidance_mode": "smile",
                "location_config": "optional",
                "redirect": false,
                "no-spinner": true,
                "default_lang": "es"
            }
        }
    }
}

Description of Methods in the JSON Configuration

Based on the provided information, here is a description of the relevant methods found within the "methods" section in the JSON configuration.

Method	Description
ReadMrz	Enables the reading of the Machine Readable Zone (MRZ) of identity documents to extract information.
VerifyData	Allows verification of the information extracted from the identity document against other sources or databases.
Images	Activates the capture and processing of images from the identity document during the verification process. (Always True)
Liveness	Performs "liveness" tests to ensure that the person presenting the document is real and not a pre-recorded image or video.
FaceMatch	Compares the real-time captured face image with the photo on the identity document to verify the match.
FacialRecognition	Enables facial recognition to identify the person, potentially comparing them with a database of faces.
FraudScoring	Applies a scoring or evaluation system to determine the risk of fraud associated with the identification operation.
StorageUpload	Allows uploading of captured images or data to remote storage or a cloud service. (Always True)
Otp	Enables authentication using One-Time Password (OTP) to add an extra layer of security to the process.
Location	Activates the capture and verification of the user's location during the identification process.
CheckFacesNumber	Verifies the number of faces detected in the captured images to ensure that only one face is presented, preventing potential fraud.

Other Configuration Parameters

Within the configuration, there are 3 distinct sections: kyc, front, and ms-service. These sections separate the logic of operations.

kyc: Related to the funnel process to be performed.
front: Defines how the information will be presented on the frontend or behaviors that can only be handled on the front.
ms-service: Related to the sending of SMS/email.

Within `kyc`:

methods: Can be true or false. If the parameter is omitted, it defaults to false.
status_post_url: Indicates a URL to make a POST request when an event is triggered, sending the operation information at that time.
status_report: The events during which the POST call will be made, as described above. In the example, it is "Verification OK," but other events like "Cancelled," "Verification KO," etc., can be configured.
fraudScoring: Additional configuration for the FraudScoring method.
allowedDocTypes/excludedDocTypes: Allows or excludes the specified document types. If left empty, all types are accepted. However, adding a type in allowedDocTypes will restrict any other document that is not declared.
crop_face: Crops the photo of the front part of the identity document.

Within `ms-service`:

email_from: The email from which the email will be sent. The client must configure DKIM and other technical aspects.
email_template: Email template hosted on SendGrid.
sms_from: Alias for the phone number from which the SMS will be sent.
sms_text: The text that will be sent in the SMS.