Skip to main content

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

HeaderRequiredDescription
x-api-keyYesYour API key
Content-TypeYesapplication/json

Body

FieldTypeRequiredDescription
emailstringYesUser's email

Response

Same format as On-Ramp and Off-Ramp APIs: success (boolean) and error (object).

StatusDescription
200Success
400Bad Request
401Unauthorized

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.