Documentation
Contact

Session KYC JAAK

Creating Session KYC by phone calls APIs

Whenever we make phone calls APIs we need those calls or requests to be authenticated, for them within the Platform JAAK have the choice to create API Kys That's our call authentication method. APIs.

The Platform JAAK, head to Adjustments - > API keys inside the menu.

Click on the button New generation API key and complete the form with the following information:

  • Name (required): Name of your API key, to be able to identify in the future.
  • Expand at (required): The length of time you wish to have API Key

Once the form has been filled out, click Save.

Copies and keeps in a secure place API key That you can't get her back in the future.

We give the option to create API key without valid, for long term automations but note the risk that this entails if you have to share it.

Now that you have a way to authenticate your phone calls APIsLet's create a Session KYCto do so, make a call API to the following URL, including the following information necessary for creating Session KYC.

URL

POST  https://api.sandbox.jaak.ai/api/v1/kyc/flow

Body:

{
  "name": "Juan Perez Perez",
  "flow": "OnBoarding",
  "redirectUrl": "https://mi-pagina.com",
  "countryDocument": "MEX",
  "flowType": "KYC",
  "verificationType": "whatsapp",
  "verification": {
    "SMS": "",
    "EMAIL": "",
    "WHATSAPP": "+522222222222"
  }
}
  • name (required): Name of person to conduct the meeting KYC
  • Flow (required): Name that you can give to the Session KYC
  • RedirectUrl (optional): If you wish to redirect the user to a specific page at the end of the Session KYC.
  • CountryDocument (required): To select the country from which you will accept documentation for Session KYCThe Alpha 3 Code name is used to refer to the country.
  • flowType (required): The type of KYC to be performed by default KYC Traditional.
  • vertiationType (optional): It's the method of notification that you prefer to send a link to a person and that can start their Session KYC from Platform KYC, the allowed options are "Whatsapp," "sms," "email" or "" (empty, to identify that you don't want to send notice).
  • vertiation.SMS (optional): If in the "vertiationType" field you select "sms" here you have to place the phone number to send the notification.
  • vertiation.EMAIL (optional): If in the "vertiationType" field you select "email" here you will have to place an email to send notice
  • vertiation.WHATSAFA (optional): If in the "verificationType" field you select "Whatsapp" here you have to place the phone number to send the notification

In your company's configuration, select a list of countries you can use to create Meetings KYCdepending on that configuration in the company are the options that you can use to create the parameter conttryDocumentTo get a complete list of countries supported, you can see here.

The number that's sent to the parameters "vertiation.SMSandvertiation.WHATSAFA"have to contain the country code, for example:

  • +52 for Mexico
  • +1 for Estados Unidos

Answer:

{
    "sessionUrl": "https://sandbox.kyc.jaak.ai/session/WIoGa8e"
}

Once the call has been made, the following will occur:

  • A notification shall be sent by the means you have chosen if so.
  • It will be responded with a URL with which you can start your Session KYC through our Platform KYC.

The ShortKey, are the last 7 characters of the URL that was created for this Session KYCKeep them because you'll need them at the next step.

The Short Keys unique to a Session KYCand are usually made up of 7 alphanumeric characters.

Integration of KYC

Two methods of implementation are available, where it will be necessary to use ShortKey and conduct a Session KYC.