API documentation

Service health

Public

Check the health of the service

GET

/api/v1/health

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

200

Request response

Key

Value

message

string

Response examples

{

message:"Service is up and running"

}

Authenticate user

Public

Login user and get access token

POST

/api/v1/auth

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

string

password

string

200

Request response

Key

Value

token

string

refreshToken

string

exp

number

Response examples

{

token:"your_access_token",

refreshToken:"your_refresh_token",

exp:0

}

Fetch account details

Private

Get account details

GET

/api/v1/account

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

200

Request response

Key

Value

_id

effects

avatar

object

string

phone

string

phoneVerified

default

name

object

contact

object

ethereum

object

typeOfUser

enum

Response examples

{

_id:"your_id",

avatar:"your_avatar",

email:"your_email",

name:{

first:"your_first_name",

last:"your_last_name"

phone:"your_phone_number"

}

Update account details

Private

Update account details

POST

/api/v1/account

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

avatar

string

name

object

string

phone

string

200

Request response

Key

Value

_id

effects

avatar

object

string

phone

string

phoneVerified

default

name

object

contact

object

ethereum

object

typeOfUser

enum

Response examples

{

_id:"your_id",

avatar:"your_avatar",

email:"your_email",

name:{

first:"your_first_name",

last:"your_last_name"

phone:"your_phone_number"

}

Fetch pet certificate

Private

Get pet certificate

GET

/api/v1/certificates/:_id

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

_id

string

200

Request response

Key

Value

name

string

description

string

external_url

string

image

object

attributes

array

healthRecords

object

Response examples

{

_id:"certificate_id",

chipId:"chip_id",

chipIdVerified:true,

chipIdProvider:"provider_name",

name:"Pet Name",

breed:"Pet Breed",

sex:"Male",

weight:10,

image:null,

type:"Dog",

owner:"owner_id",

dateOfBirth:"2023-01-01T00:00:00.000Z",

tokenId:null,

transactionHash:null,

verifiedVets:[

"vet_1",

"vet_2"

issuedAt:"2023-01-01T00:00:00.000Z",

description:"Certificate Description",

external_url:"https://example.com",

attributes:[

{

trait_type:"Color",

value:"Brown"

{

trait_type:"Vaccinated",

value:true

}

healthRecords:[]

}

Create pet certificate

Private

Create and mint pet certificate

POST

/api/v1/certificates

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

name

string

breed

string

image

object

chipId

string

policyNo

string

proof

effects

locale

enum

200

Request response

Key

Value

_id

effects

chipId

string

chipIdVerified

default

chipIdProvider

string

name

string

breed

string

sex

enum

weight

default

image

object

type

enum

owner

effects

dateOfBirth

date

tokenId

string

transactionHash

string

verifiedVets

array

issuedAt

default

Response examples

{

_id:"certificate_id",

chipId:"chip_id",

chipIdVerified:false,

chipIdProvider:"provider_name",

name:"Pet Name",

breed:"Pet Breed",

sex:"Male",

weight:10,

image:null,

type:"Dog",

owner:"owner_id",

dateOfBirth:"2023-01-01T00:00:00.000Z",

tokenId:null,

transactionHash:null,

verifiedVets:[

"vet_1",

"vet_2"

issuedAt:"2023-01-01T00:00:00.000Z"

}

Add verified vet

Private

Add verified vet to pet certificate

GET

/api/v1/vets

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

vetId

string

certificateId

string

200

Request response

Key

Value

success

boolean

Response examples

{

success:true

}

Remove verified vet

Private

Delete verified vet to pet certificate

DELETE

/api/v1/vets/:vetId/:certificateId

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

vetId

string

certificateId

string

200

Request response

Key

Value

success

boolean

Response examples

{

success:true

}

Get pet visit

Private

Get pet visit

GET

/api/v1/visits/:_id/

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

_id

effects

200

Request response

Key

Value

Response examples

{

_id:"65a3c2f7e4b0d5a901c84e1b",

tokenId:"1",

petId:"65a3c2f7e4b0d5a901c84e1c",

vetId:"65a3c2f7e4b0d5a901c84e1d",

healthRecords:{

weight:12.5,

temperature:38.2,

vaccinations:[

{

name:"Rabies",

date:"2025-04-15T14:30:00.000Z",

expiryDate:"2026-04-15T14:30:00.000Z"

{

name:"DHPP",

date:"2025-04-15T14:30:00.000Z",

expiryDate:"2026-04-15T14:30:00.000Z"

}

medications:[

{

name:"Heartworm Prevention",

dosage:"1 tablet monthly",

startDate:"2025-04-15T14:30:00.000Z",

endDate:"2025-10-15T14:30:00.000Z"

}

allergies:[

"Chicken",

"Certain Antibiotics"

diagnoses:[

"Mild skin irritation"

]

visitDate:"2025-05-10T10:15:30.000Z",

notes:"Regular checkup. Pet is in good health overall with slight skin irritation that should be monitored.",

transactionHash:"0x3a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b"

}

Add pet visit

Private

Create pet visit

POST

/api/v1/visits/:_id/

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

Request payload

Key

Value

healthRecords

object

petId

effects

200

Request response

Key

Value

_id

effects

tokenId

string

petId

effects

vetId

effects

healthRecords

object

visitDate

default

notes

string

transactionHash

string

Response examples

{

_id:"65a3c2f7e4b0d5a901c84e1b",

tokenId:"1",

petId:"65a3c2f7e4b0d5a901c84e1c",

vetId:"65a3c2f7e4b0d5a901c84e1d",

healthRecords:{

weight:12.5,

temperature:38.2,

vaccinations:[

{

name:"Rabies",

date:"2025-04-15T14:30:00.000Z",

expiryDate:"2026-04-15T14:30:00.000Z"

{

name:"DHPP",

date:"2025-04-15T14:30:00.000Z",

expiryDate:"2026-04-15T14:30:00.000Z"

}

medications:[

{

name:"Heartworm Prevention",

dosage:"1 tablet monthly",

startDate:"2025-04-15T14:30:00.000Z",

endDate:"2025-10-15T14:30:00.000Z"

}

allergies:[

"Chicken",

"Certain Antibiotics"

diagnoses:[

"Mild skin irritation"

]

visitDate:"2025-05-10T10:15:30.000Z",

notes:"Regular checkup. Pet is in good health overall with slight skin irritation that should be monitored.",

transactionHash:"0x3a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b"

}

Fetch user transactions

Private

Get user transactions

GET

/api/v1/transactions

Request authorization

Key

Value

Authorization

Bearer <string>

Request headers

Key

Value

Content-Type

application/json

X-API-Version

string

X-API-Key

string

200

Request response

Key

Value

Response examples

{

chainId:"167009",

ecosystems:[],

blockNumber:1353389,

txIndex:1,

timestamp:"2025-05-06T19:25:36.000Z",

from:{

id:"0x58869B9ce0FD8A59c20d285bd2fcb0aff7652356",

isContract:false

to:{

id:"0xEB4Cb80834220a6B5b803BB5E038F59E0af14751",

isContract:true

txHash:"0x20fae1707d7f7aff08f2440c3f435ad0c636cd793cb18fa9834820a6bb48211a",

value:"0",

gasPrice:"1212000000",

burnedFees:"153805224000000",

methodId:"0xe4ed6c80",

type:"evm_tx",

status:true

}