| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Merchant's Site Inspection
Retrieves the site inspection record for a merchant application. The site inspection captures details about the merchant's business location, including how and where inventory is stored, the physical characteristics of the premises, zoning classification, and answers to a compliance questionnaire. This data is required as part of the underwriting review for certain merchant types.
Endpoint
GET /api/v1/merchant/siteInspection
Authentication
Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:
Authorization: Basic {base64(username:password)}
When to use
Use this endpoint to retrieve the stored site inspection data for a merchant application during underwriting review or when displaying the site inspection section of the boarding form. Risk management teams and underwriters use this data to assess the merchant's physical business presence.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | The unique internal ID of the merchant application |
Response
200 OK
The data object is of type TsysSiteInspection.
| Field | Type | Description |
|---|---|---|
| inventoryMaintainedType | string (enum) | Where inventory is stored: "OnSite", "WarehouseOffSite", "FulfillmentCenter" |
| fulfillmentCenterNameAndAddress | string | Name and address of the fulfillment center (when inventoryMaintainedType is "FulfillmentCenter") |
| question1 | boolean | Answer to compliance question 1 |
| question1Explanation | string | Explanation for question 1 (when answer is true) |
| question2 | boolean | Answer to compliance question 2 |
| question2Explanation | string | Explanation for question 2 (when answer is true) |
| question3 | boolean | Answer to compliance question 3 |
| question3Explanation | string | Explanation for question 3 (when answer is true) |
| question4 | boolean | Answer to compliance question 4 |
| question4Explanation | string | Explanation for question 4 (when answer is true) |
| zoning | string (enum) | Zoning classification of the business location: "Comml" (Commercial), "Industrial", "Residential" |
| squareFootageType | string (enum) | Size bracket of the premises: "From_0_To_500", "From_501_To_1000", "From_1001_To_2000", "From_2001_To_4000", "Other" |
| squareFootageTypeOther | integer (int32) | Exact square footage (when squareFootageType is "Other") |
| merchant | string (enum) | Whether the merchant "Owns" or "Leases" the premises |
| nameAddressLandlord | string | Name and address of the landlord (when merchant is "Leases") |
| status | string | HTTP status string (e.g., "OK") |
| error | string | Error message if the request failed |
| warning | string | Non-fatal warning message |
| validationResults | array | List of validation errors, each with memberNames and errorMessage |
| requestId | integer (int32) | Internal request tracking ID |
{
"data": {
"inventoryMaintainedType": "OnSite",
"fulfillmentCenterNameAndAddress": null,
"question1": false,
"question1Explanation": null,
"question2": false,
"question2Explanation": null,
"question3": true,
"question3Explanation": "Merchant has a secondary storage unit at 456 Elm St, Miami, FL 33101",
"question4": false,
"question4Explanation": null,
"zoning": "Comml",
"squareFootageType": "From_501_To_1000",
"squareFootageTypeOther": null,
"merchant": "Leases",
"nameAddressLandlord": "Metro Property Group, 789 Main Blvd, Miami, FL 33102"
},
"status": "OK",
"error": null,
"warning": null,
"validationResults": [],
"requestId": 88542
}Error Codes
| Code | When it happens |
|---|---|
| 400 | The id query parameter is missing or not a valid integer |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No site inspection record found for the given merchant id |
| 500 | Internal server error |
Common Mistakes
- Omitting
fulfillmentCenterNameAndAddresswheninventoryMaintainedTypeis"FulfillmentCenter"— this field becomes required in that case. - Omitting
squareFootageTypeOtherwhensquareFootageTypeis"Other"— the numeric value must be provided. - Omitting
nameAddressLandlordwhenmerchantis"Leases"— landlord information is required for leased premises. - Providing an explanation for a question that was answered
false— explanations are only expected when the corresponding question istrue.
Related Endpoints
PUT /api/v1/merchant/siteInspection— update the site inspection data for a merchant applicationGET /api/v1/merchant/account— retrieve the merchant's sales and business profileGET /api/v1/merchant/parameters— retrieve the merchant's business and owner information
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/siteInspection?id=10045" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "Accept: application/json"