# Validate receivable

Validate a receivable's uniqueness in the credit rights registry.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Banking - Credit receivables",
    "contact": {
      "email": "support@pismo.com.br",
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "description": "Endpoints to handle contract operations",
    "license": {
      "name": "Copyright Pismo",
      "url": "https://developers.pismo.io/licenses/"
    },
    "termsOfService": "https://developers.pismo.io/terms/",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api-sandbox.pismolabs.io/credit-rights-receivable",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "Receivable",
      "description": "Endpoints to manage receivables"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "schemas": {
      "CorrelationID": {
        "type": "string",
        "description": "Correlation ID (CID). This field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If one isn't passed, one is automatically generated. You can find the CID in a response header. \n",
        "example": "88474990237-94940"
      },
      "DebtorDocumentNumber": {
        "type": "string",
        "description": "Debtor document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Must not be the same as the lender document number. \n",
        "maxLength": 14
      },
      "Errors": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "FaceValue": {
        "type": "number",
        "description": "Face value refers to the nominal or stated value of a financial instrument or asset, typically printed or stated on the instrument itself. It represents the initial value assigned to the instrument at the time of issuance or purchase.\n",
        "example": 499.23
      },
      "GetUniqueReceivableRequest": {
        "type": "object",
        "properties": {
          "params": {
            "$ref": "#/components/schemas/GetUniqueReceivableRequestParams"
          }
        },
        "required": [
          "params"
        ]
      },
      "GetUniqueReceivableRequestParams": {
        "type": "object",
        "properties": {
          "debtor_document_number": {
            "$ref": "#/components/schemas/DebtorDocumentNumber"
          },
          "face_value": {
            "$ref": "#/components/schemas/FaceValue"
          },
          "interop_holding_number": {
            "$ref": "#/components/schemas/InteropHoldingNumber"
          },
          "lender_document_number": {
            "$ref": "#/components/schemas/LenderDocumentNumber"
          },
          "maturity_date": {
            "$ref": "#/components/schemas/MaturityDate"
          }
        },
        "required": [
          "debtor_document_number",
          "face_value",
          "interop_holding_number",
          "lender_document_number",
          "maturity_date"
        ]
      },
      "GetUniqueReceivableResponse": {
        "type": "object",
        "properties": {
          "debtor_document_number": {
            "$ref": "#/components/schemas/DebtorDocumentNumber"
          },
          "face_value": {
            "$ref": "#/components/schemas/FaceValue"
          },
          "interop_holding_number": {
            "$ref": "#/components/schemas/InteropHoldingNumber"
          },
          "lender_document_number": {
            "$ref": "#/components/schemas/LenderDocumentNumber"
          },
          "maturity_date": {
            "$ref": "#/components/schemas/MaturityDate"
          },
          "message": {
            "$ref": "#/components/schemas/Message"
          }
        }
      },
      "GlobalErrorResponse": {
        "type": "object",
        "properties": {
          "correlationId": {
            "$ref": "#/components/schemas/CorrelationID"
          },
          "errors": {
            "$ref": "#/components/schemas/Errors"
          }
        }
      },
      "InteropHoldingNumber": {
        "type": "string",
        "description": "Client-assigned interoperation holding number. Called `holding_number` when passed in the Register receivable endpoint.\n",
        "example": "017917411A"
      },
      "LenderDocumentNumber": {
        "type": "string",
        "description": "Lender document number. A government document number, such as a Social Security number (US) or Cadastro de Pessoas Fisicas number (Brazil). Should not be the same as the debtor document number. \n",
        "example": "51407165000113"
      },
      "MaturityDate": {
        "type": "string",
        "description": "Maturity date. Format = yyyy-mm-dd. Must be equal to today or later.",
        "example": "2023-06=22"
      },
      "Message": {
        "type": "string",
        "description": "Message",
        "maxLength": 500,
        "example": "Credit rights update request is being processed"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GlobalErrorResponse"
            }
          }
        }
      },
      "401Unauthorized": {
        "description": "Missing or invalid access token",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GlobalErrorResponse"
            }
          }
        }
      },
      "500InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GlobalErrorResponse"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "JWT",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "paths": {
    "/v1/credit-rights/unicity": {
      "post": {
        "operationId": "validateUnicity",
        "summary": "Validate receivable",
        "description": "Validate a receivable's uniqueness in the credit rights registry.",
        "tags": [
          "Receivable"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetUniqueReceivableRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "Success response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetUniqueReceivableResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```