Site Survey

Get site survey

get

Retrieve the site survey record associated with the specified merchant.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Responses

200

Returns a Site Survey successfully.

application/json

siteTypeIDstring · min: 1 · max: 4Required

Site values are from 1 to 4, representing different site types. Possible values: 1 - Other 2 - BrickAndMortar 3 - Tradeshow 4 - Residence

Example: 3

otherSiteTypeDescriptionstring · nullableOptional

Description of the site type, used when SiteTypeID is 1 (Other).

Example: Mobile Kiosk

siteSurveyConductedInPersonstringRequired

Indicates whether the site survey was conducted in person.

Example: true

merchantAcquisitionTypeIDstring · min: 1 · max: 3 · nullableOptional

The type of merchant acquisition. Valid values are from 1 to 3, representing acquisition methods.

Example: 2

validIDVerifiedstringRequired

Indicates whether a valid ID has been verified.

Example: true

inventoryMatchesProductSoldstringRequired

Indicates whether the inventory matches the products being sold.

Example: false

inventoryMatchesProductSoldCommentsstring · nullableOptional

Additional comments if the inventory does not match the products being sold.

Example: The inventory contains outdated models not listed in the product catalog.

agreementAcceptedstringRequired

Indicates whether the agreement has been accepted by the merchant.

Example: true

selfSignUpApplicationbooleanOptional

Indicates whether the application was submitted via self-sign-up.

Example: false

204

No content.

400

Bad Request: If merchant number is null or empty.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: Site Survey not found.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get/api/demographics/v1/SiteSurveys/{merchantNumber}

HTTPcURLJavaScriptPython

GET /api/demographics/v1/SiteSurveys/{merchantNumber} HTTP/1.1
Accept: */*

{
  "siteTypeID": "3",
  "otherSiteTypeDescription": "Mobile Kiosk",
  "siteSurveyConductedInPerson": "true",
  "merchantAcquisitionTypeID": "2",
  "validIDVerified": "true",
  "inventoryMatchesProductSold": "false",
  "inventoryMatchesProductSoldComments": "The inventory contains outdated models not listed in the product catalog.",
  "agreementAccepted": "true",
  "selfSignUpApplication": false
}

Update site survey

put

Update an existing site survey record for the specified merchant.

Note: The updated site survey must include the following details in request body:

• SiteSurveyId
• Agreement acceptance status
• Site description
• Additional metadata

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Body

application/json

siteTypeIDstring · min: 1 · max: 4Required

Site values are from 1 to 4, representing different site types. Possible values: 1 - Other 2 - BrickAndMortar 3 - Tradeshow 4 - Residence

Example: 3

otherSiteTypeDescriptionstring · nullableOptional

Description of the site type, used when SiteTypeID is 1 (Other).

Example: Mobile Kiosk

siteSurveyConductedInPersonstringRequired

Indicates whether the site survey was conducted in person.

Example: true

merchantAcquisitionTypeIDstring · min: 1 · max: 3 · nullableOptional

The type of merchant acquisition. Valid values are from 1 to 3, representing acquisition methods.

Example: 2

validIDVerifiedstringRequired

Indicates whether a valid ID has been verified.

Example: true

inventoryMatchesProductSoldstringRequired

Indicates whether the inventory matches the products being sold.

Example: false

inventoryMatchesProductSoldCommentsstring · nullableOptional

Additional comments if the inventory does not match the products being sold.

Example: The inventory contains outdated models not listed in the product catalog.

agreementAcceptedstringRequired

Indicates whether the agreement has been accepted by the merchant.

Example: true

selfSignUpApplicationbooleanOptional

Indicates whether the application was submitted via self-sign-up.

Example: false

Responses

200

Saves a Site Survey successfully.

application/json

siteTypeIDstring · min: 1 · max: 4Required

Site values are from 1 to 4, representing different site types. Possible values: 1 - Other 2 - BrickAndMortar 3 - Tradeshow 4 - Residence

Example: 3

otherSiteTypeDescriptionstring · nullableOptional

Description of the site type, used when SiteTypeID is 1 (Other).

Example: Mobile Kiosk

siteSurveyConductedInPersonstringRequired

Indicates whether the site survey was conducted in person.

Example: true

merchantAcquisitionTypeIDstring · min: 1 · max: 3 · nullableOptional

The type of merchant acquisition. Valid values are from 1 to 3, representing acquisition methods.

Example: 2

validIDVerifiedstringRequired

Indicates whether a valid ID has been verified.

Example: true

inventoryMatchesProductSoldstringRequired

Indicates whether the inventory matches the products being sold.

Example: false

inventoryMatchesProductSoldCommentsstring · nullableOptional

Additional comments if the inventory does not match the products being sold.

Example: The inventory contains outdated models not listed in the product catalog.

agreementAcceptedstringRequired

Indicates whether the agreement has been accepted by the merchant.

Example: true

selfSignUpApplicationbooleanOptional

Indicates whether the application was submitted via self-sign-up.

Example: false

400

Bad request: If merchant number is null or empty, or data is invalid.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: Resource not found exception.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

put/api/demographics/v1/SiteSurveys/{merchantNumber}

HTTPcURLJavaScriptPython

PUT /api/demographics/v1/SiteSurveys/{merchantNumber} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 363

{
  "siteTypeID": "3",
  "otherSiteTypeDescription": "Mobile Kiosk",
  "siteSurveyConductedInPerson": "true",
  "merchantAcquisitionTypeID": "2",
  "validIDVerified": "true",
  "inventoryMatchesProductSold": "false",
  "inventoryMatchesProductSoldComments": "The inventory contains outdated models not listed in the product catalog.",
  "agreementAccepted": "true",
  "selfSignUpApplication": false
}

{
  "siteTypeID": "3",
  "otherSiteTypeDescription": "Mobile Kiosk",
  "siteSurveyConductedInPerson": "true",
  "merchantAcquisitionTypeID": "2",
  "validIDVerified": "true",
  "inventoryMatchesProductSold": "false",
  "inventoryMatchesProductSoldComments": "The inventory contains outdated models not listed in the product catalog.",
  "agreementAccepted": "true",
  "selfSignUpApplication": false
}