Petnow LogoPetnow

Create a capture session

Create a capture session before you upload images. A capture session collects the fingerprint and appearance images of one capture and records its purpose. Pass its `id` to the upload routes and then to `addFingerprints`, `verify`, or `identify`. A verification session needs `petId`.

POST
/v2/capture-sessions

Authorization

VendorApiKeyAuth
x-petnow-api-key<token>

An API key from the Petify Console. A server key can call every route. A client (app) key can only create capture sessions and upload images.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.petify.petnow.io/v2/capture-sessions" \  -H "Content-Type: application/json" \  -d '{    "species": "DOG",    "purpose": "PET_PROFILE_REGISTRATION"  }'
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

{
  "errors": [
    {
      "code": "PETNOWB2B10001"
    }
  ]
}

{
  "errors": [
    {
      "code": "PETNOWB2B10000"
    }
  ]
}
{
  "errors": [
    {
      "code": "PETNOWB2B10010"
    }
  ]
}
{
  "errors": [
    {
      "code": "PETNOWB2B20000"
    }
  ]
}
{
  "errors": [
    {
      "code": "PETNOWB2B10015"
    }
  ]
}