> ## Documentation Index > Fetch the complete documentation index at: https://docs.escrybe.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Get a registered e-mail status ## OpenAPI ````yaml /openapi/escrybe.en.yaml get /api/email/v1/get/{securityToken}/{job_id} openapi: 3.1.0 info: title: Escrybe API version: 1.0.0 description: > REST API for the Escrybe platform — send physical letters, registered letters, telegrams and e-Carta through Brazilian Correios, dispatch legally registered e-mails, and send WhatsApp messages with certified timestamps. ## Authentication Every account has a personal **`securityToken`** (find it in the panel under *Account → API*). Three products use it differently: | Product | Scheme | How | |---------|--------|-----| | Letters / Telegram / e-Carta, Registered E-mail, Receipts | API token | Send `userSecurityToken` as a query/body parameter, or `securityToken` as a header | | WhatsApp | HTTP Basic | `Authorization: Basic base64(email:securityToken)` | > The letter and e-mail **read** routes (`get`, `balance`, `download`, > `delete`) take the token as the first URL **path** segment — e.g. > `/api/v2/get/{securityToken}/{job_id}`. ## Response envelopes Most endpoints reply with the standard envelope `{"status": , "status_message": "...", "data": ...}` — this covers Letters/Telegram, Registered E-mail, and the WhatsApp message and sender endpoints. The WhatsApp **template** endpoints (and template sync) use `{"code": , "status": "success|error", "message": "...", "data": ..., "request_id": "..."}`; the logo endpoint uses the same shape without `request_id`. See the schema of each endpoint. A request that is accepted returns an HTTP `200` with a success payload; validation problems return `400`, bad credentials `401`, and forbidden access `403`. Unsupported HTTP methods return `405`, repeated failed authentication attempts return `429`, and the letter and e-mail endpoints return `503` during maintenance windows. contact: name: Escrybe Support url: https://escrybe.com.br servers: - url: https://app.escrybe.com.br description: Production - url: https://homolog.escrybe.com.br description: Staging security: - securityTokenQuery: [] tags: - name: Letters & Telegram description: Create and manage letter, telegram and e-Carta orders (Correios). - name: Account & Favorites description: Account balance, saved contacts and sender logo. - name: Registered E-mail description: Send and track legally registered e-mails. - name: WhatsApp Messages description: Send WhatsApp messages and download certified-timestamp attestations. - name: WhatsApp Senders description: Manage WhatsApp Business numbers (senders). - name: WhatsApp Templates description: Create, sync and manage WhatsApp message templates. - name: Receipts description: Download legal receipts for any order. paths: /api/email/v1/get/{securityToken}/{job_id}: get: tags: - Registered E-mail summary: Get a registered e-mail status operationId: getEmail parameters: - $ref: '#/components/parameters/SecurityTokenPath' - $ref: '#/components/parameters/JobIdPath' responses: '200': description: E-mail found content: application/json: schema: allOf: - $ref: '#/components/schemas/EmailEnvelope' - properties: data: $ref: '#/components/schemas/EmailDetail' '400': $ref: '#/components/responses/EmailBadRequest' '401': $ref: '#/components/responses/EmailUnauthorized' '503': $ref: '#/components/responses/EmailMaintenance' security: [] components: parameters: SecurityTokenPath: name: securityToken in: path required: true schema: type: string description: Your account security token (used as authentication). JobIdPath: name: job_id in: path required: true schema: type: string description: >- Order visual id — digits for letters/telegrams (e.g. 2607031); registered e-mail ids start with `E` (e.g. E2607031). schemas: EmailEnvelope: type: object description: Same standard envelope as the letters endpoints. properties: status: type: integer example: 200 status_message: type: string data: oneOf: - type: object - type: string - type: 'null' EmailDetail: type: object properties: id: type: string name: type: string email: type: string name_sender: type: string subject: type: string msg: type: string attachment_name: type: string nullable: true status: type: integer description: >- 0 Processing payment · 1 Production (awaiting send) · 2 Insufficient credits · 3 Sent · 4 Cancelled · 5 Failed delivered: type: integer opened: type: integer deferred: type: integer description: >- 1 when the recipient's mail server deferred the message (the order is failed and credits are refunded). date_sent: type: string nullable: true date_delivered: type: string nullable: true date_opened: type: string nullable: true dateSubmit: type: string dateLastChange: type: string paymentMethod: type: string value: type: number tag: type: string responses: EmailBadRequest: description: Invalid or incomplete request content: application/json: schema: $ref: '#/components/schemas/EmailEnvelope' example: status: 400 status_message: Requisição incompleta data: null EmailUnauthorized: description: Invalid token content: application/json: schema: $ref: '#/components/schemas/EmailEnvelope' example: status: 401 status_message: Token inválido data: null EmailMaintenance: description: Server under maintenance content: application/json: schema: $ref: '#/components/schemas/EmailEnvelope' securitySchemes: securityTokenQuery: type: apiKey in: query name: userSecurityToken description: >- Your account security token, sent as the `userSecurityToken` query or form parameter. ````