Our new version of APIs(v2) is callback-based APIs, So if you have not set up a callback URL till now, Please set it from brick dashboard.

Success Response

Sync Response

{
         "status": 202,
          data:{         
               "message": "We are processing your request and will send the data in the callback URL."
               “job_id”:”XXXX-XXXX-XXXX-XXXX”
          },
          metadata:{
               "source": {{API/Widget/Dashboard/SDK/Portal}}, 
               "entity": {{Data/Insight/Verification/Payment}}         
        },
        error: null, 
 }

Explantion of every field
status - HTTP/HTTPS status code
message- Text message
job_id - Unique transaction_id, It will help to map Async response
source - It defines from where APIs request is coming, It can be either one from API, Widget, Dashabord, SDK or Portal.
entity - It defines which product the APIs request is coming from, It can be either one from Data, Insight, Verification, or Payments.
error- Incase of success, Error will be null

Async Response

{
    "status": 200,
     "data": {
            "message": “We are successfully able to fetch data”,
            "example-1":"XXXX-XXXX-XXXX",
            "count":{{Number of objects}},
            "example-2"{[
                 "array1":1,
                 "example-3":"xx-xx-xx" 
                 ],[
                 "array2":1,
                 "example-4":"xx-xx-xx"
            ]}  
    },
    metadata:{
        "source": {{API/Widget/Dashboard/SDK/Portal}}, 
        "entity": {{Data/Insight/VErification/Payment}}         
   },
   error: null 
}

Explantion of every field
status - HTTP/HTTPS status code
message- Text message
data- Response data
source - It defines from where APIs request is coming, It can be either one from API, Widget, Dashabord, SDK or Portal.
entity - It defines which product the APIs request is coming from, It can be either one from Data, Insight, Verification, or Payments.
error - Incase of success, Error will be null

Error Response

Below is a structure of Unsuccessful responses.

{ 
           "status" : XXX,        
           “error”:{
                  "code": {{brick_unique_error_code}}, 
                  "message": {{description_of_error}}, 
                  "action": {{further_action}},
                  "reason": {{Actual_reason_for_error}}
          }, 
          “metadata”:{
                  "source": {{API/Widget/Dashboard/SDK/Portal}}, 
                  "entity": {{Auth/Insight/Verification/Payment}}
         },
         data:null 
 }

Explanation for every field

status - HTTP/HTTPS status code
code - Brick customized status code
message - Error message for showing to end-users
action- Further action to prevent this error
reason- Actual reason of the error
source - It defines from where APIs request is coming, It can be either one from API, Widget, Dashabord, SDK or Portal.
entity - It defines which product the APIs request is coming from, It can be either one from Data, Insight, Verification, or Payments.

📘

Below is a list of possible "code" that can be returned, along with a description and action.

Client Side Errors

Server Side Errors