Skip to main content
POST
/
vbook
/
search
Search Verification Book
curl --request POST \
  --url https://api-stage.karmacheck.io/vbook/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "searchDetails": {
    "vbookTypeId": "<string>",
    "nameQuery": "<string>"
  },
  "listMetadata": {
    "page": 123,
    "pageSize": 123
  }
}
'
{
  "listMetadata": {
    "page": 123,
    "pageSize": 123,
    "totalPages": 123
  },
  "results": [
    {
      "id": "<string>",
      "city": "<string>",
      "state": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
searchDetails
searchDetails · object
required

Details to perform the search with.

listMetadata
ListMetadata · object

Data for how you want the results returned. Not providing this results in page = 0 and pageSize = 10.

Response

OK

listMetadata
object
results
PublicVerificationBookItem · object[]