Kyc init

Request otp to initialise the KYC flow

POST /abdm/v1/profile/kyc/init

cURL

cURL

curl --request POST \
  --url https://api.eka.care/abdm/v1/profile/kyc/init \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "user_x_token": "<string>"
}
'

import requests

url = "https://api.eka.care/abdm/v1/profile/kyc/init"

payload = {
    "identifier": "<string>",
    "user_x_token": "<string>"
}
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({identifier: '<string>', user_x_token: '<string>'})
};

fetch('https://api.eka.care/abdm/v1/profile/kyc/init', 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.eka.care/abdm/v1/profile/kyc/init",
  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([
    'identifier' => '<string>',
    'user_x_token' => '<string>'
  ]),
  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.eka.care/abdm/v1/profile/kyc/init"

	payload := strings.NewReader("{\n  \"identifier\": \"<string>\",\n  \"user_x_token\": \"<string>\"\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.eka.care/abdm/v1/profile/kyc/init")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identifier\": \"<string>\",\n  \"user_x_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/abdm/v1/profile/kyc/init")

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  \"identifier\": \"<string>\",\n  \"user_x_token\": \"<string>\"\n}"

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

200

{
  "txn_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id · string

Eka User ID (OID)

X-Partner-Pt-Id · string

Partner User ID

X-Hip-Id · string

Partner HIP ID

Query Parameters

oid · string

OID is used to Identify the user.

Body

application/json

identifier · string · required

The identifier, which will be the 14-digit ABHA number for the 'abha-number' method or the 12-digit Aadhaar number for the 'aadhaar' method.

method · enum<string> · required

The method used for KYC, such as ABHA number or Aadhaar.

Available options: abha-number, aadhaar

user_x_token · string

user authorization token

Response

200

application/json

OK

txn_id · string

Transaction ID required for the next API call.