1. Schedules
FigoVerify Public API
  • VerifyAddress
    • Create And Geocode A Customer
      POST
    • Geocode An Address
      POST
  • BulkVerifyAddress
    • Submit A Bulk Geocode Job
      POST
    • List Bulk Geocode Jobs
      GET
    • Get A Bulk Geocode Job
      GET
  • SubmitGeoLocation
    • Submit A Location Ping
      POST
  • VerifyBVN
    • Verify A BVN
      POST
  • VerifyNIN
    • Verify A NIN
      POST
  • WalletBalance
    • Get Wallet Balance
      GET
  • ProximityScore
    • Get Customer Proximity Summary
      GET
  • Schedules
    • Get Collection Schedules For A Customer
      GET
  • DocumentVerification
    • Verify A CAC Certificate Image
      POST
    • Verify A CAC Certificate PDF
      POST
    • Verify A Driver's Licence
      POST
    • Verify A Generic ID Card
      POST
    • Verify A MemArt Or Form CO2
      POST
    • Verify A National ID Card
      POST
    • Verify A NIN Slip
      POST
    • Verify An International Passport
      POST
    • Verify A Proof Of Address
      POST
    • Verify A Voter's Card
      POST
  • Schemas
    • ApiResponse
    • DefaultResponse
    • AddressRiskSignals
    • BillingInfo
    • BulkGeocodeItem
    • BulkGeocodeRequest
    • GeocodeData
    • BulkGeocodeSubmitEnvelope
    • BulkGeocodeSubmitResponse
    • BulkItemResponse
    • CustomerGeocodeData
    • BulkRefDetailEnvelope
    • BulkRefDetailResponse
    • VerifyAddressInfo
    • BulkRefListEnvelope
    • VerifyValidationField
    • BvnBillingInfo
    • GeoLocationData
    • BulkRefSummaryResponse
    • WalletBalanceResponse
    • VerifyValidationResult
    • BvnData
    • VerifyIdData
    • BvnVerificationInfo
    • CacCertificatePdfVerificationRequest
    • DefaultServiceResponse
    • CacCertificateVerificationRequest
    • CustomerGeocodeEnvelope
    • CustomerGeocodeRequest
    • CustomerGeocodeResponse
    • VerifyBVNData
    • ServiceResponse
    • DirectorShareInfo
    • GeoSchedulesData
    • GeocodeResponseEnvelope
    • DocumentVerificationApiResponse
    • CustomerGeocodeResponseEnvelope
    • DocumentVerificationResponseData
    • VerifyNINData
    • GeoLocationResponseEnvelope
    • DriversLicenceVerificationRequest
    • ErrorResponse
    • VerifyBVNResponseEnvelope
    • WalletBalanceData
    • VerifyNINResponseEnvelope
    • GeoLocationEnvelope
    • GeoLocationRequest
    • GeoLocationResponse
    • ProximityScoreData
    • GeoScheduleItem
    • WalletBalanceResponseEnvelope
    • ProximityScoreResponseEnvelope
    • GeoSchedulesEnvelope
    • BulkGeocodeSubmitResponseEnvelope
    • GeoSchedulesResponseEnvelope
    • GeocodeEnvelope
    • GeocodeRequest
    • GeocodeResponse
    • ErrorEnvelope
    • IdCardVerificationRequest
    • MemArtFormCo2VerificationRequest
    • NationalIdVerificationRequest
    • NearbyPlace
    • NinData
    • NinSlipVerificationRequest
    • PassportVerificationRequest
    • ProofOfAddressVerificationRequest
    • ProximityScoreEnvelope
    • ProximityScoreResponse
    • PublicGeoSchedulesResponse
    • StreetViewImage
    • UnauthorizedResponse
    • VerificationInfo
    • VerifyBVNEnvelope
    • VerifyBVNRequest
    • VerifyBVNResponse
    • VerifyNINEnvelope
    • VerifyNINRequest
    • VerifyNINResponse
    • VotersCardVerificationRequest
    • WalletBalance
    • WalletBalanceEnvelope
  1. Schedules

Get Collection Schedules For A Customer

Developing
GET
/api/v1/public/customer/geo-schedules/{customerId}
Returns the location-collection windows configured for your company, together with a collectData flag the client app should use to decide whether to keep capturing pings for this customer. The flag is true while the customer's stored ping count is below the sum of all maxCount values, and false once that quota is met or when no schedules are configured at all.

Request

Authorization
API Key
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
or
Path Params

Responses

🟢200
application/json
Schedules and collection flag returned.
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/public/customer/geo-schedules/' \
--header 'X-Api-Key: <api-key>'
Response Response Example
200 - Example 1
{
    "status": true,
    "message": "Operation successful.",
    "data": {
        "schedules": [
            {
                "schedule": "08:00-10:00",
                "maxCount": 10
            }
        ],
        "collectData": true
    }
}
Modified at 2026-08-06 11:58:31
Previous
Get Customer Proximity Summary
Next
Verify A CAC Certificate Image
Built with