Skip to main content
GET
/
v1
/
provider-kyc
/
{providerId}
Get Provider KYC
curl --request GET \
  --url https://api.monime.io/v1/provider-kyc/{providerId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.monime.io/v1/provider-kyc/{providerId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.monime.io/v1/provider-kyc/{providerId}', 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.monime.io/v1/provider-kyc/{providerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/provider-kyc/{providerId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.monime.io/v1/provider-kyc/{providerId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/provider-kyc/{providerId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "account": {
      "id": "<string>",
      "name": "<string>",
      "holderName": "<string>",
      "metadata": {}
    },
    "provider": {
      "id": "m17",
      "type": "momo",
      "name": "Orange Money"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Path Parameters

​
providerId
string
required

The ID of the provider as identified by Monime.

Query Parameters

​
accountId
string
required

The ID of the account in the provider's ecosystem'.

Response

200 - application/json

OK

​
success
boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

​
messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

​
result
Provider KYC · object

A Provider KYC object represents the know-your-customer (KYC) information retrieved from a financial provider (e.g., Mobile Money operator, Bank).