Initiate Cl@ve

curl --request POST \
  --url https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_url": "https://yourapp.com/kyc/callback",
  "customize": {
    "company_name": "Acme Rentals",
    "company_logo": "https://yourapp.com/logo.png"
  }
}
'

import requests

url = "https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}"

payload = {
    "redirect_url": "https://yourapp.com/kyc/callback",
    "customize": {
        "company_name": "Acme Rentals",
        "company_logo": "https://yourapp.com/logo.png"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    redirect_url: 'https://yourapp.com/kyc/callback',
    customize: {company_name: 'Acme Rentals', company_logo: 'https://yourapp.com/logo.png'}
  })
};

fetch('https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'redirect_url' => 'https://yourapp.com/kyc/callback',
    'customize' => [
        'company_name' => 'Acme Rentals',
        'company_logo' => 'https://yourapp.com/logo.png'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}"

	payload := strings.NewReader("{\n  \"redirect_url\": \"https://yourapp.com/kyc/callback\",\n  \"customize\": {\n    \"company_name\": \"Acme Rentals\",\n    \"company_logo\": \"https://yourapp.com/logo.png\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"redirect_url\": \"https://yourapp.com/kyc/callback\",\n  \"customize\": {\n    \"company_name\": \"Acme Rentals\",\n    \"company_logo\": \"https://yourapp.com/logo.png\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"redirect_url\": \"https://yourapp.com/kyc/callback\",\n  \"customize\": {\n    \"company_name\": \"Acme Rentals\",\n    \"company_logo\": \"https://yourapp.com/logo.png\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Bankflip Url",
  "data": {
    "id": "session_01HXYZ1234567890",
    "clave_url": "https://example.bankflip.io/session/session_01HXYZ1234567890"
  }
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

Tenants

Initiate Cl@ve

Initiates the Cl@ve identity verification process for a tenant.

Asynchronous Operation

This endpoint initiates an Asynchronous process. The API response confirms that the Cl@ve flow has been started, While document downloads are completed in the background.

How this flow works:

Provide a redirect_url where the tenant should be redirected after completing verification.
The API will respond with a verification link.
Redirect the tenant to the provided link.
The tenant completes identity verification by entering their details on the Cl@ve page.
After successful verification, identity documents are automatically downloaded.
Once the process is complete, call Get Tenant Documents to retrieve the downloaded documents.

Important:

The redirect_url must be a valid, publicly accessible URL.
customize is optional. Without it, the Cl@ve screens show the SKOR name and logo. Send customize.company_name and/or customize.company_logo to show your own instead.
Document availability depends on successful completion of the Cl@ve flow.
This endpoint only initiates the process; it does not return documents immediately.

Clave completion webhook: When Clave flow is completed successfully, a webhook event CLAVE_SUCCESS is sent.

The webhook payload contains:

event: Event name (CLAVE_SUCCESS)
data: null (This webhook event is used only to indicate that the Clave flow has completed successfully and documents are downloaded)

The configured webhook endpoint must accept POST requests.

POST

tenants

initiate-clave

{tenantId}

Initiate Cl@ve

curl --request POST \
  --url https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_url": "https://yourapp.com/kyc/callback",
  "customize": {
    "company_name": "Acme Rentals",
    "company_logo": "https://yourapp.com/logo.png"
  }
}
'

import requests

url = "https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}"

payload = {
    "redirect_url": "https://yourapp.com/kyc/callback",
    "customize": {
        "company_name": "Acme Rentals",
        "company_logo": "https://yourapp.com/logo.png"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    redirect_url: 'https://yourapp.com/kyc/callback',
    customize: {company_name: 'Acme Rentals', company_logo: 'https://yourapp.com/logo.png'}
  })
};

fetch('https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'redirect_url' => 'https://yourapp.com/kyc/callback',
    'customize' => [
        'company_name' => 'Acme Rentals',
        'company_logo' => 'https://yourapp.com/logo.png'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}"

	payload := strings.NewReader("{\n  \"redirect_url\": \"https://yourapp.com/kyc/callback\",\n  \"customize\": {\n    \"company_name\": \"Acme Rentals\",\n    \"company_logo\": \"https://yourapp.com/logo.png\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"redirect_url\": \"https://yourapp.com/kyc/callback\",\n  \"customize\": {\n    \"company_name\": \"Acme Rentals\",\n    \"company_logo\": \"https://yourapp.com/logo.png\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skortorent.com/api/v1/tenants/initiate-clave/{tenantId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"redirect_url\": \"https://yourapp.com/kyc/callback\",\n  \"customize\": {\n    \"company_name\": \"Acme Rentals\",\n    \"company_logo\": \"https://yourapp.com/logo.png\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Bankflip Url",
  "data": {
    "id": "session_01HXYZ1234567890",
    "clave_url": "https://example.bankflip.io/session/session_01HXYZ1234567890"
  }
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication. Generate a shared token via /authenticate/token, then pass it as Authorization: Bearer <token>.

Path Parameters

tenantId

string

required

Body

application/json

redirect_url

string<uri>

required

URL to redirect the tenant after completing Cl@ve verification

Example:

"https://yourapp.com/kyc/callback"

customize

object

Optional. Branding shown on the Cl@ve screens. By default the SKOR name and logo are used; any value you send here replaces it.

Show child attributes

Response

Cl@ve verification session created successfully

status

enum<string>

required

Available options:

success

message

string

required

Example:

"Bankflip Url"

data

object

required

Show child attributes

Guides

SDK

API's Authentication

Modular API Guide

Modular API Reference

Property Management Guide

Property Management API Reference

Initiate Cl@ve

Asynchronous Operation

Authorizations

Path Parameters

Body

Response