ArdentaxIT logo
BusinessesPartnersProduct Wiki

Request Account Onboard OTP

Use this endpoint to send a one-time password (OTP) to an account email so that a downstream account can be onboarded under your partner integration. See the right panel for the base URL, request samples, and response JSON.

When you call this API, ArdentaxIT validates your partner access token and the provided account email, then generates a one-time verification code and sends it to that email address. The OTP is valid for 2 minutes from the time it is issued.

Rate limit

5 OTP sends per hour per partner organization and account email. See Rate limiting for details and retry guidance.

Authentication

This endpoint requires a JWT access token issued to your partner integration:

  • The token must be obtained using your partner client_id and client_secret.

  • Pass the token in the Authorization header as Bearer <partner_jwt_token>.

Request body
FieldTypeRequiredDescription
emailstring
Required
The account email that should receive the onboarding OTP (for example, user@example.com). This must be an email that belongs to the account you want to onboard under your partner organization.
Response

Status code: 200 OK

Returns a confirmation message indicating that a verification code has been sent to the provided account email.

Error responses
StatusDescription
400 Bad RequestThe request body is invalid or required fields are missing.
401 UnauthorizedAuthentication required, the JWT is invalid, or it was not issued for a partner client.
403 ForbiddenThe authenticated partner is not allowed to send an onboarding OTP for this account.
429 Too Many RequestsRate limit exceeded (see Rate limiting).
500 Internal Server ErrorAn error occurred while processing the request.
Next