Sign in

v1

latestOpenAPI 3.0.12026-07-2356172250.9 KB
Site Survey

Get site survey

Retrieve the site survey record associated with the specified merchant.

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

Path parameters

merchantNumberstring required

The merchant's unique identification number.

Response

Returns a Site Survey successfully.

siteTypeIDstring required

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

otherSiteTypeDescriptionstring nullable

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

siteSurveyConductedInPersonstring required

Indicates whether the site survey was conducted in person.

merchantAcquisitionTypeIDstring nullable

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

validIDVerifiedstring required

Indicates whether a valid ID has been verified.

inventoryMatchesProductSoldstring required

Indicates whether the inventory matches the products being sold.

inventoryMatchesProductSoldCommentsstring nullable

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

agreementAcceptedstring required

Indicates whether the agreement has been accepted by the merchant.

selfSignUpApplicationboolean

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