Integrate Become Re-Verefication service to your website with Become reverification web button

How it looks like in your code:

<become-reverification-button
  userId="<YOUR_USER_ID>"
  contractId="<YOUR_CONTRACT_ID>"
  token="<YOUR_JWT_TOKEN>"
/>

How it looks like on your page:

Integrate

Add the following script to your html:

<script src="https://onboarding.svi.becomedigital.net/resources/reverification-button.js"></script>

Use and declare the userId, contractId, and token in the custom element:

<become-reverification-button
  userId="<YOUR_USER_ID>"
  contractId="<YOUR_CONTRACT_ID>"
  token="<YOUR_JWT_TOKEN>"
/>

Note: You can also create the button dynamically using JavaScript. Use the createElement method, and then apply setAttribute to define the attributes. You can also handle or simulate a click event to control whether or not to display the button on your page.

const button = document.createElement('become-reverification-button');
button.setAttribute('userId', 'user_12345');
button.setAttribute('contractId', 'contract_67890');
button.setAttribute('token', 'your_jwt_token_here');
document.body.appendChild(button);

API Reference

Re-verification

Once a user has completed the onboarding process, they will be able to authenticate using facial biometrics and proof of life (liveness detection), without needing to present their identity document again.

• Reverification API

executionId

When the re-verification process is initiated, the API generated a unique executionId to identify the transaction. This value can be used in two ways:

• Immediate Use: The verification results can be processed immediately after receiving the executionId.
• Future Query: The executionId can be stored for use at any point in the process, allowing the results to be queried later.

To obtain the results using the executionId, use the following endpoint:

POST https://api.svi.becomedigital.net/api/v1/matches/check

For more details about this endpoint and the result format, refer to the official API documentation.

For more information about where to find this key please refer to result table below.

Button attributes

Attribute name	Description
userId	The custom unique identifier assigned during the previous validation process.
contractId	Contract identifier for validation type
token	The JWT token generated for API requests, created using company credentials.

Events

You can subscribe to events emitted by the button to track the re-verification process. The most important events include:

EventName	Description
become:sdkLoaded	Indicates that the SDK was loaded successfully.
become:verificationStarted	Notifies that the re-verification process has started.
become:result	Indicates the successful completion of the re-verification process; data is returned.
become:userFinishedSdk	Notifies that the user clicked the continue button to close the SDK. Only emmited when the verification proccess is OK
become:exitedSdk	Indicates that the user exited the process manually using the close button. Here users may complete the proccess or not

document.querySelector('become-reverification-button').addEventListener('become:result', (event) => {
    console.log('Resultado de la re-verificación:', event.detail);
});
/* or
 const btn = document.querySelector('become-reverification-button');
 btn.addEventListener('become:result', (event) => {
 // handle your next step or bussiness logic;
  console.log('Resultado de la re-verificación:', event.detail);
 });
 btn.addEventListener('become:userFinishedSdk', (event) => {
  // handle your next step or bussiness logic;
 });
*/

When the result event is triggered, the following data is returned:

{
  "userId": "test_1",
  "livenessConfidence": 99.91615295410156,
  "auditImages": [
    {
      "BoundingBox": {
        "Height": 283.93048095703125,
        "Left": 218.52137756347656,
        "Top": 105.67168426513672,
        "Width": 193.6444854736328
      },
      "Bytes": ""
    }
  ],
  "referenceImage": {
    "BoundingBox": {
      "Height": 287.81195068359375,
      "Left": 206.05030822753906,
      "Top": 76.31394958496094,
      "Width": 201.10231018066406
    },
    "Bytes": ""
  },
  "data": {
    "company": "<YOUR_COMPANY_ACCOUNT_NAME>",
    "user_id": "<USER_ID>",
    "result": false,
    "confidence": 0.20414,
    "liveness": 99.91615295410156,
    "executionId": "UUID",
  }
}

Result Object

Key	Type	Description
livenessConfidence	Number (Decimal)	The percentage of confidence in the user's liveness during the challenge. If the score is >= 75, it indicates the user is likely a real person (not necessarily that the user is who they claim to be).
auditImages	Array	An array containing the images used as base images for liveness verification.
referenceImage	Object	The reference image used to compare and verify if the user is live.
data	Object	The result of the comparison between the most recent selfie and the one attached to the userId.
userId	String	The unique identifier used to initiate the re-verification process.

Note:

• auditImages.Bytes and referenceImage.Bytes are Base64-encoded images. These images are not saved on our end, so if you need them, please ensure you handle them appropriately.

Data information

data contains the response from our service, indicating whether the user is who they claim to be.

Key	Type	Description
company	String	The company from where the user was onboarded (your company).
user_id	String	The user ID of the individual (same as provided).
liveness	Number (Decimal)	The percentage of confidence in the user's liveness during the challenge. If the score is >= 75, it indicates the user is likely a real person (not necessarily that the user is who they claim to be).
result	Boolean	Indicates whether the user passed re-verification. true means the user is verified; false means they are not.
confidence	Number (Decimal)	The comparison score between the sent selfie and the one attached to the userId. You can use this value for custom logic if needed, based on your business rules.
executionId	UUID (String)	The unique identifier for this transaction.

Example

• Minimal usage:
  • Vanilla JS: see index.html
• Using the Image to call re-verfication API examples/index.js