🚀 Business API Developer Portal

Authenticate via ClientId and ClientSecret to receive a JWT token.

Endpoint

POST /api/business-auth/token

Parameters

Parameter	Required	Description
clientId	Yes	Client ID on your dashboard
clientSecret	Yes	Secret password sent to your email
TimeZone	Yes	leave out if you are in West Africa else state it

Response

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Copy Response

Example (cURL)

curl -X POST "https://accesscheckglobal.com/api/business-auth/token" \
-H "Content-Type: application/json" \
-d '{
  "clientId": "business-client-123",
  "clientSecret": "super-secret-password",
  "timezone": "timezone",
}'

Copy cURL

Regenerate a new Client Secret for a business client. A notification email will be sent with the new secret.

Endpoint

GET /api/business/regenerateSecret?clientId=your-client-id

Parameters

Parameter	Required	Description
clientId	Yes	The unique ID of the business client whose secret you want to regenerate.

Success Response

"Successfully generated, please check your email for security purpose"

cURL Example

curl -X GET "https://accesscheckglobal.com/api/business/regenerateSecret?clientId=business-client-123"

Copy cURL

Retrieve a WhatsApp template by name. No authentication required.

Endpoint

GET /api/business/get-whatsapp-template?templateName=WeddingInvite

Parameters

Parameter	Required	Description
Name	Yes	Template name
Language	Yes	Language code
Status	Yes	Approval status
Category	Yes	Template category
Components	Yes	List of template components (HEADER, BODY, FOOTER)
Type	Yes	Component type: HEADER, BODY, or FOOTER
Text	Conditional	Text content for BODY or FOOTER
Format	Conditional	Format for HEADER component

cURL Example

curl -X GET "https://accesscheckglobal.com/api/business/get-whatsapp-template?templateName=WeddingInvite"

Copy cURL

Retrieve a list of all available WhatsApp templates in your account. No authentication is required.

cURL Example

curl -X GET "https://accesscheckglobal.com/api/business/get-whatsapp-templates"

Copy cURL

Response Example

[
  {
    "name": "WeddingInvite",     
    "language": "en",            
    "status": "approved",        
    "category": "Marketing" 
  },
  {
    "name": "OTP",
    "language": "en",
    "status": "approved",
    "category": "Utility"
  }
]

Copy Response

Parameter Description

Property	Description
name	Template name
language	Language code of the template (e.g., "en")
status	Approval status (e.g., approved, pending, rejected)
category	Category of the template (Utility, Template, Authentication.)

Send or schedule WhatsApp messages via template.

Parameters

Parameter	Required	Description
TemplateName	Yes	WhatsApp template name
FileUrl	No	Image, video, PDF, or Word file URL
PlaceHolders	Yes	List of recipients with placeholders,Parameter is option if none exist on the template
PhoneNumber	Yes	Recipient phone number
SendAt	No	Optional delivery time, leave out for immediate send FORMAT => "dd/MM/yyyy HH:mm:ss"
Parameters	Yes	Dictionary of template placeholders and values

cURL Example

curl -X POST "https://accesscheckglobal.com/api/business/send-whatsapp" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "TemplateName": "WeddingInvite",   
  "FileUrl": "https://cdn.example.com/file.pdf",
  "PlaceHolders": [
    {
      "PhoneNumber": "+2348012345678", 
      "SendAt": "2025-09-10T15:00:00",  
      "Parameters": {
        "firstName": "John",
        "eventDate": "10th Sep 2025"
      }
    },
    {
      "PhoneNumber": "+2348098765432",
      "Parameters": {
        "firstName": "Jane",
        "eventDate": "10th Sep 2025"
      }
    }
  ]
}'

Copy cURL