Commercial Emails - KYC
Submit a user's email to send KYC-related commercial communications. The endpoint is hosted at https://api.platform.onmeta.in (base URL may differ by environment).
Endpoint
POST /v1/commercial-emails/kyc
Request
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
Content-Type | Yes | application/json |
Body
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | User's email |
Response
Same format as On-Ramp and Off-Ramp APIs: success (boolean) and error (object).
| Status | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
Success (200)
{
"success": true,
"error": {}
}
Failure (4xx)
{
"success": false,
"error": {
"code": 400,
"message": "Bad Request"
}
}
cURL example
curl --location 'https://api.platform.onmeta.in/v1/commercial-emails/kyc' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"email":"adinath@onmeta.in"
}'
Replace YOUR_API_KEY with your actual API key and the email value with the recipient's email address.