Create

Create

curl --request POST \
  --url https://api.eka.care/abdm/na/v1/registration/mobile/create-phr \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "abha_address": "<string>",
  "profile": {
    "day_of_birth": 1,
    "first_name": "Shyam",
    "gender": "M",
    "month_of_birth": 1,
    "pincode": "110001",
    "year_of_birth": 1990,
    "address": "123, ABC Street",
    "last_name": "Singh",
    "middle_name": "Kumar"
  },
  "txn_id": "<string>"
}
'

import requests

url = "https://api.eka.care/abdm/na/v1/registration/mobile/create-phr"

payload = {
    "abha_address": "<string>",
    "profile": {
        "day_of_birth": 1,
        "first_name": "Shyam",
        "gender": "M",
        "month_of_birth": 1,
        "pincode": "110001",
        "year_of_birth": 1990,
        "address": "123, ABC Street",
        "last_name": "Singh",
        "middle_name": "Kumar"
    },
    "txn_id": "<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({
    abha_address: '<string>',
    profile: {
      day_of_birth: 1,
      first_name: 'Shyam',
      gender: 'M',
      month_of_birth: 1,
      pincode: '110001',
      year_of_birth: 1990,
      address: '123, ABC Street',
      last_name: 'Singh',
      middle_name: 'Kumar'
    },
    txn_id: '<string>'
  })
};

fetch('https://api.eka.care/abdm/na/v1/registration/mobile/create-phr', 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/na/v1/registration/mobile/create-phr",
  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([
    'abha_address' => '<string>',
    'profile' => [
        'day_of_birth' => 1,
        'first_name' => 'Shyam',
        'gender' => 'M',
        'month_of_birth' => 1,
        'pincode' => '110001',
        'year_of_birth' => 1990,
        'address' => '123, ABC Street',
        'last_name' => 'Singh',
        'middle_name' => 'Kumar'
    ],
    'txn_id' => '<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/na/v1/registration/mobile/create-phr"

	payload := strings.NewReader("{\n  \"abha_address\": \"<string>\",\n  \"profile\": {\n    \"day_of_birth\": 1,\n    \"first_name\": \"Shyam\",\n    \"gender\": \"M\",\n    \"month_of_birth\": 1,\n    \"pincode\": \"110001\",\n    \"year_of_birth\": 1990,\n    \"address\": \"123, ABC Street\",\n    \"last_name\": \"Singh\",\n    \"middle_name\": \"Kumar\"\n  },\n  \"txn_id\": \"<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/na/v1/registration/mobile/create-phr")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"abha_address\": \"<string>\",\n  \"profile\": {\n    \"day_of_birth\": 1,\n    \"first_name\": \"Shyam\",\n    \"gender\": \"M\",\n    \"month_of_birth\": 1,\n    \"pincode\": \"110001\",\n    \"year_of_birth\": 1990,\n    \"address\": \"123, ABC Street\",\n    \"last_name\": \"Singh\",\n    \"middle_name\": \"Kumar\"\n  },\n  \"txn_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/abdm/na/v1/registration/mobile/create-phr")

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  \"abha_address\": \"<string>\",\n  \"profile\": {\n    \"day_of_birth\": 1,\n    \"first_name\": \"Shyam\",\n    \"gender\": \"M\",\n    \"month_of_birth\": 1,\n    \"pincode\": \"110001\",\n    \"year_of_birth\": 1990,\n    \"address\": \"123, ABC Street\",\n    \"last_name\": \"Singh\",\n    \"middle_name\": \"Kumar\"\n  },\n  \"txn_id\": \"<string>\"\n}"

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

{
  "eka": {
    "min_token": "<string>",
    "oid": "<string>",
    "uuid": "<string>"
  },
  "profile": {
    "abha_address": "shyam@abdm",
    "abha_addresses": [
      "<string>"
    ],
    "abha_number": "12-3456-7856-8912",
    "address": "<string>",
    "day_of_birth": 123,
    "first_name": "<string>",
    "gender": "M",
    "kyc_verified": true,
    "last_name": "<string>",
    "middle_name": "<string>",
    "mobile": "<string>",
    "month_of_birth": 123,
    "pincode": "<string>",
    "year_of_birth": 123
  },
  "refresh_token": "<string>",
  "skip_state": "abha_end",
  "success": true,
  "token": "<string>"
}

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

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

POST

abdm

registration

mobile

create-phr

Create

curl --request POST \
  --url https://api.eka.care/abdm/na/v1/registration/mobile/create-phr \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "abha_address": "<string>",
  "profile": {
    "day_of_birth": 1,
    "first_name": "Shyam",
    "gender": "M",
    "month_of_birth": 1,
    "pincode": "110001",
    "year_of_birth": 1990,
    "address": "123, ABC Street",
    "last_name": "Singh",
    "middle_name": "Kumar"
  },
  "txn_id": "<string>"
}
'

import requests

url = "https://api.eka.care/abdm/na/v1/registration/mobile/create-phr"

payload = {
    "abha_address": "<string>",
    "profile": {
        "day_of_birth": 1,
        "first_name": "Shyam",
        "gender": "M",
        "month_of_birth": 1,
        "pincode": "110001",
        "year_of_birth": 1990,
        "address": "123, ABC Street",
        "last_name": "Singh",
        "middle_name": "Kumar"
    },
    "txn_id": "<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({
    abha_address: '<string>',
    profile: {
      day_of_birth: 1,
      first_name: 'Shyam',
      gender: 'M',
      month_of_birth: 1,
      pincode: '110001',
      year_of_birth: 1990,
      address: '123, ABC Street',
      last_name: 'Singh',
      middle_name: 'Kumar'
    },
    txn_id: '<string>'
  })
};

fetch('https://api.eka.care/abdm/na/v1/registration/mobile/create-phr', 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/na/v1/registration/mobile/create-phr",
  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([
    'abha_address' => '<string>',
    'profile' => [
        'day_of_birth' => 1,
        'first_name' => 'Shyam',
        'gender' => 'M',
        'month_of_birth' => 1,
        'pincode' => '110001',
        'year_of_birth' => 1990,
        'address' => '123, ABC Street',
        'last_name' => 'Singh',
        'middle_name' => 'Kumar'
    ],
    'txn_id' => '<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/na/v1/registration/mobile/create-phr"

	payload := strings.NewReader("{\n  \"abha_address\": \"<string>\",\n  \"profile\": {\n    \"day_of_birth\": 1,\n    \"first_name\": \"Shyam\",\n    \"gender\": \"M\",\n    \"month_of_birth\": 1,\n    \"pincode\": \"110001\",\n    \"year_of_birth\": 1990,\n    \"address\": \"123, ABC Street\",\n    \"last_name\": \"Singh\",\n    \"middle_name\": \"Kumar\"\n  },\n  \"txn_id\": \"<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/na/v1/registration/mobile/create-phr")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"abha_address\": \"<string>\",\n  \"profile\": {\n    \"day_of_birth\": 1,\n    \"first_name\": \"Shyam\",\n    \"gender\": \"M\",\n    \"month_of_birth\": 1,\n    \"pincode\": \"110001\",\n    \"year_of_birth\": 1990,\n    \"address\": \"123, ABC Street\",\n    \"last_name\": \"Singh\",\n    \"middle_name\": \"Kumar\"\n  },\n  \"txn_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/abdm/na/v1/registration/mobile/create-phr")

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  \"abha_address\": \"<string>\",\n  \"profile\": {\n    \"day_of_birth\": 1,\n    \"first_name\": \"Shyam\",\n    \"gender\": \"M\",\n    \"month_of_birth\": 1,\n    \"pincode\": \"110001\",\n    \"year_of_birth\": 1990,\n    \"address\": \"123, ABC Street\",\n    \"last_name\": \"Singh\",\n    \"middle_name\": \"Kumar\"\n  },\n  \"txn_id\": \"<string>\"\n}"

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

{
  "eka": {
    "min_token": "<string>",
    "oid": "<string>",
    "uuid": "<string>"
  },
  "profile": {
    "abha_address": "shyam@abdm",
    "abha_addresses": [
      "<string>"
    ],
    "abha_number": "12-3456-7856-8912",
    "address": "<string>",
    "day_of_birth": 123,
    "first_name": "<string>",
    "gender": "M",
    "kyc_verified": true,
    "last_name": "<string>",
    "middle_name": "<string>",
    "mobile": "<string>",
    "month_of_birth": 123,
    "pincode": "<string>",
    "year_of_birth": 123
  },
  "refresh_token": "<string>",
  "skip_state": "abha_end",
  "success": true,
  "token": "<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

Body

application/json

abha_address

string

required

The ABHA address to be created for the user.

profile

object

required

Profile details of the user.

Show child attributes

txn_id

string

required

Transaction ID received in the previous API response.

Response

eka

object

Eka IDs, will be present if SkipState is abha_end

Show child attributes

profile

object

Show child attributes

refresh_token

null | string

Refresh token of the user, issued by abdm

skip_state

enum<string>

Available options:

abha_end,

confirm_mobile_otp,

abha_select,

abha_create

success

boolean

Indicates whether the API response is successful

token

null | string

Abha token of the user, issued by abdm

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Authorizations

Headers

Body

Response