# Credit Situation

Este método se conecta a la  y retorna la situación crediticia del CUIT/CUIL proporcionado.

El uso del campo  desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir  con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo  pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones

Endpoint: POST /v1/ar/services/bcra.gob.ar/credit-situation
Version: v1.0
Security: JWT, Api-Key

## Request fields (application/json):

  - `RequestData` (object, required)
    Information needed to consult for the user.

  - `RequestData.DocumentNumber` (string, required)
    CUIT/CUIL associated to the entity.
    Example: "000011887755"

  - `CallbackUrl` (string)
    URL to send the response message using a POST verb.
    Example: "https://my-api.my-business.com/api/open-data-response"

## Response 200 fields (application/json):

  - `OperationId` (string, required)
    Unique identifier of the operation.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Operation status.  means that the service was executed successfully even if it does not return Data.  indicates that something happened that prevented the successful completion of the process.
    Enum: "OK", "ERROR"

  - `Data` (object,null, required)
    Container for credit situation.

  - `Data.Situation` (array)

  - `Data.Situation.Entity` (string, required)
    Denomination of the informant Entity
    Example: "BANCA CENTRAL DE ARGENTINA"

  - `Data.Situation.Situation` (string, required)
    Indicator for the debtor's classification indicated by the Entity
    Enum: "Normal Situation", "With special follow-up", "With issues", "With high risk of insolvency", "Non-recoverable", "Non-recoverable due to technical disposition"

  - `Data.Situation.Amount` (object, required)
    Amount of money informed by the entity

  - `Data.Situation.Amount.Amount` (number, required)
    A number of monetary units specified in an active currency where the unit of currency is expressed in thousands of the unit.
    Example: 10

  - `Data.Situation.Amount.Currency` (string, required)
    A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
    Example: "ARS"

  - `Data.Situation.DaysOfDelay` (string)
    If the debtor belongs to the portfolio for consumption or housing in an abnormal status, is classified by refinancing, obligated recategorization, legal situation -judical or extrajudical concordants, preventive bankrupcy, judical gestion or bankrupcy- or irrecoverable due to technical disposition, the days of delay will be informed, the text 'N/A' indicates 'Not Applicable'
    Example: "N/A"

  - `AdditionalInformation` (string,null, required)
    This field can be used to display relevant information specific to the response, for instance indicating that the  field is incomplete.

  - `Error` (object,null, required)
    Object with the error details, used when . If  this field will be null. You can read a complete explanation of this object visiting [this link](https://docs.khipu.com/portal/en/errors/)

  - `Error.Code` (string)
    Internal system code that identifies the error.
    Example: "E201"

  - `Error.Type` (string)
    Indicates how to treat this specific error code, based on the type of error.
    Enum: "RETRY_IMMEDIATELY", "DO_NOT_RETRY", "WAIT_4_HOURS_BEFORE_RETRY", "RETRY_AFTER_NOTIFICATION"

  - `Error.Description` (string)
    Description associated with the error code.
    Example: "El servicio destino utilizado para la extracción de datos no se encuentra disponible."

  - `LifeSpan` (string,null, required)
    in sync requests.

## Response 202 fields (application/json):

  - `OperationId` (string, required)
    Unique identifier of the operation.
    Example: "6baf6c19-e485-463b-ae24-a821b025c8a4"

  - `Status` (string, required)
    Operation status. When making async requests it will always return .
    Example: "OK"

  - `Data` (object, required)
    in async requests.

  - `AdditionalInformation` (string, required)
    Operation message, can be used to display additional information.
    Example: "Data will be sent to the callback URL."

  - `Error` (object, required)
    in async requests.

  - `LifeSpan` (string, required)
    Max estimated delivery date for async requests, in ISO 8601 date format, UTC timezone.
    Example: "2017-07-22T00:00:00-0400"