• Status codes
  • Domain and scope error codes
  • API key error codes
  • Developer error codes
  • Passcode error codes
  • File error codes
  • Server error codes
  • Tracking error codes
  • Refresh Secret error codes
  • Refresh API key error codes
  • Security error codes
  • Generic error codes
  • Cache error codes
  • Other error codes
• Notification information
  • Passcode consent operations
  • Passcode revoke operations
  • Tracking file operations
  • File upload operations

Status codes

Each time any error occurs, as part of the response you’ll find a error code (in addition to the corresponding HTTP status code). Find below the list of error codes and descriptions:

Domain and scope error codes

API key error codes

Developer error codes

Passcode error codes

File error codes

Server error codes

Tracking error codes

Refresh Secret error codes

Refresh API key error codes

Security error codes

Generic error codes

Cache error codes

Other error codes

Notification information

Some operations described in the API reference section that end with a notification that the platform will send to the other side. All notifications are given following the format below:

{
    "type": "NOTIFICATION TYPE",
    "payload": 
    {
        "NOTIFICATION OBJECT"
    }
}

In this section, you could find the payload and details that will come with each notification.

Passcode consent operations

• SDI will notify to the 3^rd party application that a passcode generated has been consented.

  {
    "type": "consent",
    "payload": 
    {
        "passcode": "<The passcode being consented>",
        "apikey": "<The API key that the 3rd party app should use to connect with the Sage product that consented the passcode>"
    }
  }
  

Passcode revoke operations

• SDI will notify to the 3^rd party application that a previous granted passcode has now been revoked.

  {
    "type": "revoke",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>"
    }
  }
  

  
  

Tracking file operations

• The file is not valid and SDI warn the owner of the file with the issues found. This is normally due to some issues with the file formar according to the JSON-schema defined. In the payload, an array with the first ten validation errors could be found.

  {
    "type": "tracking",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>",
        "scope": "<The name of the scope that the files belongs to>",
        "trackingUrl": "<This is the URL given in the response of the completeURL POST operation>",
        "status": "forbidden",
        "errors":
        {
            {
                "line": <Line number of the JSON file where the error resides>,
                "kind": "<Type of error produced during the schema validation process>",
                "message": "<Error message>"
            },
            {
                "line": <Line number of the JSON file where the error resides>,
                "kind": "<Type of error produced during the schema validation process>",
                "message": "Error message"
            },
            ...
            {
                "line": <Line number of the JSON file where the error resides>,
                "kind": "<Type of error produced during the schema validation process>",
                "message": "<Error message>"
            }
        }
    }
  }
  

  
  

• The progress processing the file has changed and the consumer is notified. This way, it’s possible to keep track of the progress and inform the user (where applies).

  {
    "type": "tracking",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>",
        "scope": "<The name of the scope that the files belongs to>",
        "trackingUrl": "<This is the URL given in the response of the completeURL POST operation>",
        "status": "processing",
        "progress": <Progress percentage updated>
    }
  }
  

  
  

• The file has been successfully delivered, validated and ingested by the consumer, but still there is no result file available (until the consumer ingest the file).

  {
    "type": "tracking",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>",
        "scope": "<The name of the scope that the files belongs to>",
        "trackingUrl": "<This is the URL given in the response of the completeURL POST operation>",
        "status": "accepted",
        "resultFileAvailable": false
    }
  }
  

  
  

• The file has been ingested in the consumer application and produced a result file with the details.

  {
    "type": "tracking",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>",
        "scope": "<The name of the scope that the files belongs to>",
        "trackingUrl": "<This is the URL given in the response of the completeURL POST operation>",
        "status": "accepted",
        "resultFileAvailable": true
    }
  }
  

  
  

• The consumer file ingestion has failed, but still there is no result file available (until the consumer produces the file with the details).

  {
    "type": "tracking",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>",
        "scope": "<The name of the scope that the files belongs to>",
        "trackingUrl": "<This is the URL given in the response of the completeURL POST operation>",
        "status": "failed",
        "resultFileAvailable": false
    }
  }
  

  
  

• The consumer file ingestion has failed and the consumer application has produced a result file with the details.

  {
    "type": "tracking",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>",
        "scope": "<The name of the scope that the files belongs to>",
        "trackingUrl": "<This is the URL given in the response of the completeURL POST operation>",
        "status": "failed",
        "resultFileAvailable": true
    }
  }
  

  
  

• The file has been delivered to the consumer, but the consumer failed processing it for any reason.

  {
    "type": "tracking",
    "payload": 
    {
        "passcode": "<The passcode that has been revoked>",
        "scope": "<The name of the scope that the files belongs to>",
        "trackingUrl": "<This is the URL given in the response of the completeURL POST operation>",
        "status": "badRequest"
    }
  }
  

  
  

File upload operations

• The platform will advice each consumer that the other side has uploaded a new file to any of the scopes available, and it’s ready to be consumed by the other side.

  {
    "type": "fileUploaded",
    "payload": 
    {
        "passcode": "<The passcode behind the integration that the new file belongs to>",
        "scope": "<The name of scope that receives the new file>"
    }
  }