---
updatedAt: 2025-11-21T15:02:21.000Z
agentTools:
  projectIndex: https://docs.pagaleve.com.br/llms.txt
---

# Verificar elegibilidade do cliente para a Pagaleve no checkout do lojista

Este endpoint verifica se um cliente pode visualizar a Pagaleve como opção de pagamento em sua plataforma.
A validação é feita com base nos dados informados (CPF, valor, telefone e e-mail).

Para utilizar este endpoint, é obrigatório gerar o token Bearer com uma API Secret e uma API Key — outros métodos de autenticação não são aceitos.



# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "PreAnalysisRequest": {
        "type": "object",
        "required": [
          "amount"
        ],
        "properties": {
          "individual_id": {
            "type": "string",
            "description": "CPF do cliente (somente números)",
            "pattern": "^[0-9]{11}$",
            "example": "90333314034",
            "minLength": 11,
            "maxLength": 11
          },
          "amount": {
            "type": "integer",
            "description": "Valor do pedido em centavos (Ex 20000 = R$ 200,00)",
            "minimum": 1,
            "maximum": 1000000,
            "example": 20000
          },
          "phone": {
            "type": "string",
            "description": "Telefone do cliente no formato (Ex: +5511943107444) é obrigatório informar +55 no início do número",
            "pattern": "^\\+55[0-9]{10,11}$",
            "example": "+5511943107444",
            "minLength": 13,
            "maxLength": 14
          },
          "email": {
            "type": "string",
            "format": "email",
            "description": "Email do cliente",
            "example": "vinicius@pagaleve.com.br",
            "maxLength": 100
          }
        }
      },
      "PreAnalysisResponse": {
        "type": "object",
        "required": [
          "action"
        ],
        "properties": {
          "action": {
            "type": "string",
            "description": "Ação indicando se o cliente está autorizado a usar Pagaleve",
            "enum": [
              "ALLOW",
              "DENY"
            ],
            "example": "ALLOW"
          }
        }
      },
      "PreAnalysisErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "Código do erro",
            "enum": [
              "VALIDATION_ERROR",
              "unauthorized"
            ],
            "example": "VALIDATION_ERROR"
          },
          "message": {
            "type": "string",
            "description": "Mensagem de erro",
            "example": "Validation exception: amount is required"
          },
          "action": {
            "type": "string",
            "description": "Ação da resposta (presente em alguns casos de erro)",
            "enum": [
              "DENY"
            ],
            "example": "DENY"
          },
          "request_id": {
            "type": "string",
            "description": "ID único da requisição para rastreamento",
            "example": "req_1234567890abcdef"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "contact": {},
    "description": "Pre-analysis API - Verifica se um cliente pode visualizar a Pagaleve como opção de pagamento em sua plataforma.",
    "title": "PRE-ANALYSIS API",
    "version": "1.0"
  },
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/checkout": {
      "post": {
        "summary": "Verificar elegibilidade do cliente para a Pagaleve no checkout do lojista",
        "description": "Este endpoint verifica se um cliente pode visualizar a Pagaleve como opção de pagamento em sua plataforma.\nA validação é feita com base nos dados informados (CPF, valor, telefone e e-mail).\n\nPara utilizar este endpoint, é obrigatório gerar o token Bearer com uma API Secret e uma API Key — outros métodos de autenticação não são aceitos.\n\n",
        "operationId": "PreAnalysisController_Checkout",
        "parameters": [],
        "tags": [
          "Checkout"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PreAnalysisRequest"
              },
              "examples": {
                "exemplo_basico": {
                  "summary": "Exemplo básico de verificação",
                  "value": {
                    "individual_id": "73973385009",
                    "amount": 20000,
                    "phone": "+5511932423419",
                    "email": "cliente@exemplo.com.br"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Verificação realizada com sucesso",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PreAnalysisResponse"
                },
                "examples": {
                  "cliente_permitido": {
                    "summary": "Cliente autorizado",
                    "value": {
                      "action": "ALLOW"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Dados de entrada inválidos",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PreAnalysisErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Não autorizado - Credenciais inválidas",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PreAnalysisErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://pre-analysis.pagaleve.com.br",
      "description": "Pre-analysis production server"
    },
    {
      "url": "https://sandbox-pre-analysis.pagaleve.io",
      "description": "Pre-analysis staging server"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```