GET /lookup:providers

Provider registry for lookups (id types + configured?)

Bearer API key or staff session operation lookupProviders

Request

This endpoint has no request body.

curl "$MONICHEK_API/lookup:providers" \
  -H "Authorization: Bearer $MONICHEK_API_KEY"

const res = await fetch(`${MONICHEK_API}/lookup:providers`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
  },
});

const data = await res.json();

import os
import requests

res = requests.get(
    f"{os.environ['MONICHEK_API']}/lookup:providers",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
)
print(res.json())

$ch = curl_init(getenv('MONICHEK_API') . '/lookup:providers');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

200 OK providers application/json

{
  "object": "list",
  "data": [
    {
      "id": "mock",
      "configured": true,
      "id_types": [
        "bvn",
        "nin",
        "passport",
        "drivers_licence",
        "voters_card",
        "cac"
      ]
    },
    {
      "id": "prembly",
      "configured": false,
      "id_types": [
        "bvn",
        "nin",
        "passport",
        "drivers_licence",
        "voters_card",
        "cac"
      ]
    }
  ]
}