Get merchant's site inspection

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

ParameterTypeRequiredDescription
idinteger (int32)YesThe unique internal ID of the merchant application

Response

200 OK

The data object is of type TsysSiteInspection.

FieldTypeDescription
inventoryMaintainedTypestring (enum)Where inventory is stored: "OnSite", "WarehouseOffSite", "FulfillmentCenter"
fulfillmentCenterNameAndAddressstringName and address of the fulfillment center (when inventoryMaintainedType is "FulfillmentCenter")
question1booleanAnswer to compliance question 1
question1ExplanationstringExplanation for question 1 (when answer is true)
question2booleanAnswer to compliance question 2
question2ExplanationstringExplanation for question 2 (when answer is true)
question3booleanAnswer to compliance question 3
question3ExplanationstringExplanation for question 3 (when answer is true)
question4booleanAnswer to compliance question 4
question4ExplanationstringExplanation for question 4 (when answer is true)
zoningstring (enum)Zoning classification of the business location: "Comml" (Commercial), "Industrial", "Residential"
squareFootageTypestring (enum)Size bracket of the premises: "From_0_To_500", "From_501_To_1000", "From_1001_To_2000", "From_2001_To_4000", "Other"
squareFootageTypeOtherinteger (int32)Exact square footage (when squareFootageType is "Other")
merchantstring (enum)Whether the merchant "Owns" or "Leases" the premises
nameAddressLandlordstringName and address of the landlord (when merchant is "Leases")
statusstringHTTP status string (e.g., "OK")
errorstringError message if the request failed
warningstringNon-fatal warning message
validationResultsarrayList of validation errors, each with memberNames and errorMessage
requestIdinteger (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

CodeWhen it happens
400The id query parameter is missing or not a valid integer
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404No site inspection record found for the given merchant id
500Internal server error

Common Mistakes

  • Omitting fulfillmentCenterNameAndAddress when inventoryMaintainedType is "FulfillmentCenter" — this field becomes required in that case.
  • Omitting squareFootageTypeOther when squareFootageType is "Other" — the numeric value must be provided.
  • Omitting nameAddressLandlord when merchant is "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 is true.

Related Endpoints

  • PUT /api/v1/merchant/siteInspection — update the site inspection data for a merchant application
  • GET /api/v1/merchant/account — retrieve the merchant's sales and business profile
  • GET /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"
Query Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json