Object

Shown below is a sample schedule_kyc object.

{
  "id": "fkyc_dd3EcZKvBg7ZhdgKfu69Quijk",
  "object": "schedule_kyc",
  "awb_number": "4807196109",
  "time_slot": "8am_to_12pm",
  "date": "2022-07-29",
  "merchant_reference_id": "1001616",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "reschedule_count": 0,
  "status": "scheduled",
  "tracking_details": {
    "message": "Successfully Updated"
  },
  "failure_reason": {},
  "accounts_id": "sa_DfDxREBkBM1lLXZ7mOB0qgHV0",
  "created_at": 1659020331,
  "is_sandbox": true
}

The table below lists the various parameters in the schedule_kyc object.

Parameter	Type	Description
id	`string`	Unique identifier of the in-person KYC verification request in the ZWITCH database. Example: `fkyc_34W2a5uwWTfQ58gZXp3ISDBMf`
object	`string`	API object that is returned. Possible value: `schedule_kyc`
awb_number	`string`	Unique identifier that can be used to track the document collection agent and the shipment post collection. This number is sent to the applicant's mobile number. Example: `1123153595`
time_slot	`string`	Timeslot for the in-person KYC verification. Possible values: `8am_to_12pm` `12pm_to_4pm` `4pm_to_8pm`
date	`string`	Date when the in-person KYC verification has been scheduled in the `YYYY-MM-DD` format. Example: `2022-12-31`
status	`string`	Status of the in-person KYC request. Possible values: `scheduled`: In-person KYC verification has been successfully scheduled. `completed`: The agent has successfully collected the required documents and we have passed on the documents to the bank for verification and further processing. `cancelled`: The request has been canceled by you or your customer. `failed`: In-person KYC verification failed. Check the In-person KYC Life Cycle Section for more details about the statuses.
merchant_reference_id	`string`	Unique identifier entered when creating the verification request. Only alphabets and numbers are allowed. Minimum: 7 characters. Maximum: 40 characters. Example: `14096850`
metadata	`object`	Object of key-value pair that can be used to store additional information about the entity. Each pair cannot exceed 256 characters. Maximum 5 key-value pairs. Example: `"key_1": "We are using Zwitch.”`
reschedule_count	`integer`	The number of times the in-person KYC verification request has been rescheduled. Example: `1` In-person KYC verification can only be rescheduled once.
tracking_details	`object`	Object that contains tracking details of the in-person KYC request. Learn more about the tracking_details child object.
failure_reason	`object`	Object that contains the reason the in-person KYC request failed. Learn more about the failure_reason child object.
accounts_id	`string`	Unique identifier of the account for which in-person KYC verification is being scheduled. Example: `sa_MKYnbQY0SR4zeThurDDeOfa4X`
created_at	`integer`	Unix timestamp when the in-person KYC verification request was received by ZWITCH. Example: `1640179951`
is_sandbox	`boolean`	The mode in which the API was triggered. Possible values: `true`: API was triggered in sandbox mode. `false`: API was triggered in live mode.

[Child Object] Tracking Details

The table below lists the various parameters in the tracking_details child object. The object is part of the schedule_kyc object.

Parameter	Type	Description
message	`string`	Tracking details of the in-person KYC request.

[Child Object] Failure Reason

The table below lists the various parameters in the failure_reason child object. The object is part of the schedule_kyc object.

Parameter	Type	Description
message	`string`	Reason the in-person KYC request failed.