wip

bifravst · Jul 2, 2024 · 93dd6c4 · 93dd6c4
1 parent 225c3a2
commit 93dd6c4
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,16 @@ Returns
 }
 ```
 
+The API will return different status codes based on different scenarios:
+
+| StatusCode | Explanation                                                                                                                                      |
+| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| 200        | The request was successful and you should get the most recent data from our database. If data is older than 5 minutes, new data will be fetched. |
+| 400        | Bad request. The request parameters didn't validate. Either not a valid iccid or from a not supported issuer.                                    |
+| 404        | Not found. The SIM doesn't exist in the issuers API. This response will be cached for 30 days.                                                   |
+| 409        | No information about SIM in cache. Try again later, and you will get either a 404 if the SIM doensn't exist or 200 with data.                    |
+| 500        | Internal Error.                                                                                                                                  |
+
 ## Installation in your AWS account
 
 ### Setup