infoOverview
About this API
This API is used to get the whatsapp business encryption key using phone number id.
keySecurity
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
Locationheader
Field name
apikeyExample value
YOUR_WABA_API_KEYrouteParameters
Path Parameters
Substitute these placeholders in the endpoint URL before sending the request.
NameTypeRequirementDescription
phone_number_idstringRequiredResource identifier for phone number id.uploadInput
Request Details
check_circle
No Request Body
Provide identifiers in the path and any supported values in the query string.
codeIntegration
Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
shield_lockCredentials protectedAdd secrets only in your secure server environment.
curl --request GET 'https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key' \
--header 'apikey: <API_KEY>'const response = await fetch('https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key', {
method: 'GET',
headers: {
"apikey": "<API_KEY>"
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);const response = await fetch('https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key', {
method: 'GET',
headers: {
"apikey": "<API_KEY>"
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);import json
import requests
url = 'https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key'
headers = {
"apikey": "<API_KEY>"
}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key"))
.header("apikey", "<API_KEY>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => ["apikey: <API_KEY>"],
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("apikey", "<API_KEY>");
var response = await client.GetAsync("https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://partnersv1.pinbot.ai/v3/flows/{phone_number_id}/get_private_key", nil)
if err != nil { panic(err) }
request.Header.Set("Accept", "application/json")
request.Header.Set("apikey", "<API_KEY>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}downloadOutput
Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{
"result": " ---- BEGIN RSA PRIVATE
KEY ---- \nMIIEpAIBAAKCAQEA4I6QAFQ7T8/bwuIDcAvjt5RFG+mHiZJUzNl4IPn5RE2F
3eHR\nclv+oXzly2FgqxzZxuAvccCRzIWojipadZ/mVA+b/3elmUQD0zY8XFd8iOZYwwVr\
nwLSKPNmF47Jfev+ePb2g4pnVk5i1f4qC7G1mmybvVTSyCyFmsGwri+uCU4D43OfR\
nkS+xjNK20ZAFsMQqhfxzOm348Ll+VcDCkLeTOWUyfJIuU+JOZm32ocAaLVPPiv92\n
cUS5yWI1gAZPBVD4rBtOvU45ROVeBIhvu8gTyZ/QmGoasb1OPb3Ao6EYNHFFiCcT\n
CbBtUVEwhD58jexY4qE6R0o3w7GXTmOZwfoLgwIDAQABAoIBAAGCBrDdlQJIQWW
9\nZApAJnsuJLIsTLXb5X1FvLjDFuowcUY1wdTr0pEXjnu5IeJnARvoqkoQ+tF3Mvy+\nk
+TOxrH4X6TinGtx7DKnJif1H6iVfQ9R57fz6VZdY+q3Qb0/eUdMySmt8a1MFyMK\nyZ6M
mXibIFasMsf4hhhJs8/XOOKJ8fX2zjDHHIACJYzIwO51xCYO0Jv5jSJd4+ks\ngDSgKIjyI
e8UlbKGoHO8nfsFK2zv7Q7mC1lUgx2zK/g9sE+xKl11KYbLV5FR0Z5O\nNGbF473xxee
raSEhC1+oFXw+wpEBjw4QMmhs9nJXxLdvvcu4b602PYRG+E6sV1Y/\nX+iMLYkCgYE
A/zeCVgEfsif+ZOELERr/aHoWLdhOmHlYC/nl38FjlX19KFIwv518\n/Tpg5oUPEhvcZeFT
/kYWWrhvVu/rNaDt5EEDwhQ/EHVrkVWCfKrtnBIO8NZpTUg3\nVx7lSdsRJ19ESBXX4t
LdYekfgQLdbAuAmAFamvZSPvqmj8abWYM+b9kCgYEA4T73\nwzaLo9OELlqU/0H8wi
YY8gCmd7fmdARYeD3f4DvD==\n-----END RSA PRIVATE KEY "
}
{
"type": "object",
"properties": {
"raw_example": {
"type": "string"
}
}
}ruleHTTP Responses
Status Codes
200The request was successful.400Bad request or invalid parameters.401API key is missing or invalid.403The request is not authorized for this resource.404The requested resource was not found.500The server encountered an error.