API REFERENCE

Verify Agent Email

On this page

POST/api/agents/verify

Verify an agent's email with the code sent during signup. Returns an API key on success.

Authentication

This endpoint does not require authentication.

Request

cURL

curl --request POST \
  --url 'https://api.recoupable.dev/api/agents/verify' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "you@example.com",
  "code": "123456"
}'

Request body required

Email and verification code

application/json

emailstringrequired

The email address used during signup.

format: email

codestringrequired

The 6-digit verification code sent to the email.

minLength: 6 · maxLength: 6 · pattern: ^[0-9]{6}$

Responses

200Verification successful

application/json

account_idstringrequired

The account ID for the verified agent.

format: uuid

api_keystringrequired

API key for the verified account.

messagestringrequired

Human-readable status message.

400Invalid or expired verification code

application/json

errorintegerrequired

format: int32

messagestringrequired

429Too many failed verification attempts

application/json

errorintegerrequired

format: int32

messagestringrequired

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download accounts.json

View operation source

json

{
  "description": "Verify an agent's email with the code sent during signup. Returns an API key on success.",
  "security": [],
  "requestBody": {
    "description": "Email and verification code",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AgentVerifyRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Verification successful",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AgentVerifyResponse"
          }
        }
      }
    },
    "400": {
      "description": "Invalid or expired verification code",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "429": {
      "description": "Too many failed verification attempts",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}