> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tratum.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# SCR — Algoritmos

> Consulta SCR — produto algoritmos.



## OpenAPI

````yaml GET /v1/scr/algorithms/{document}
openapi: 3.1.0
info:
  title: Tratum API
  description: >-
    Esta documentação fornece as informações necessárias para integrar-se ao
    nosso ecosistema. Nossas APIs permite que os clientes enviem solicitações
    para analisar, consultar, monitorar dados associados a um documento
    específico.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://search.tratum.com.br
security:
  - bearerAuth: []
paths:
  /v1/scr/algorithms/{document}:
    get:
      tags:
        - Procrédito (SCR)
      summary: Algoritmos (SCR)
      operationId: scrConsultAlgorithms
      parameters:
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
            nullable: true
        - name: document
          in: path
          required: true
          schema:
            type: string
        - name: planId
          in: query
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Cache, plano sem permissão SCR, ou corpo de sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrConsultResponse200'
        '202':
          description: Consulta enfileirada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrConsultAccepted'
        '400':
          description: CPF/CNPJ inválido após normalizar (não possui 11 nem 14 dígitos)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrInvalidDocument'
        '403':
          description: Usuário sem acesso à organização do plano (ErrorForbiddenException)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrForbidden'
components:
  schemas:
    ScrConsultResponse200:
      description: >-
        HTTP 200: ou bloqueio por plano (`PLAN_NOT_ALLOWED`), ou sucesso a
        partir do cache (`SUCCESS` + `source: cache`).
      oneOf:
        - $ref: '#/components/schemas/ScrResponsePlanNotAllowed'
        - $ref: '#/components/schemas/ScrResponseSuccessCached'
    ScrConsultAccepted:
      type: object
      description: >-
        HTTP 202 — consulta aceita e enviada à fila SQS
        (`ScrController.publishToSqs` / `acceptedResponse`).
      required:
        - status
        - message
      properties:
        status:
          type: string
          enum:
            - PROCESSING
          description: Status fixo ao enfileirar.
        message:
          type: string
          example: A consulta está sendo processada.
    ScrInvalidDocument:
      type: object
      description: >-
        HTTP 400 — documento com quantidade de dígitos inválida após remover
        máscara (`documentValidationError`).
      required:
        - status
        - message
      properties:
        status:
          type: string
          enum:
            - INVALID_DOCUMENT
        message:
          type: string
          description: 'Ex.: esperado CPF (11) ou CNPJ (14 dígitos).'
    ScrForbidden:
      type: object
      description: >-
        HTTP 403 — `ErrorForbiddenException` tratada por
        `GlobalExceptionHandler` (ex.: usuário sem vínculo com a organização do
        plano). Campos podem vir nulos no corpo; a mensagem textual pode constar
        no status line.
      properties:
        type:
          type:
            - string
            - 'null'
        message:
          type:
            - string
            - 'null'
    ScrResponsePlanNotAllowed:
      type: object
      description: >-
        HTTP 200 quando o plano não tem SCR habilitado (`resolvePlanContext` /
        `planNotAllowed`).
      required:
        - status
        - message
      properties:
        status:
          type: string
          enum:
            - PLAN_NOT_ALLOWED
        message:
          type: string
          example: Seu plano não permite acesso a este recurso
    ScrResponseSuccessCached:
      type: object
      description: >-
        HTTP 200 com resultado anterior em cache. O campo `data`, quando
        presente, reflete o payload JSON da última consulta bem-sucedida junto
        ao provedor SCR.
      required:
        - status
        - source
      properties:
        status:
          type: string
          enum:
            - SUCCESS
        document:
          type: string
          description: Documento (somente dígitos), alinhado ao cache.
        data:
          type: object
          additionalProperties: true
          description: >-
            Payload JSON retornado pelo provedor da consulta SCR, quando a
            última execução persistiu corpo de resposta.
        score:
          type: integer
          format: int32
          nullable: true
          description: Pontuação associada ao resultado em cache (quando aplicável).
        classification:
          type: string
          nullable: true
          description: Classificação da pontuação no resultado em cache (quando aplicável).
        source:
          type: string
          enum:
            - cache
          description: Indica leitura do histórico local em vez de nova consulta.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````