Product Docs
Community

Integration Flow

Learn about the API you need to integrate with to use ZWITCH's In-person KYC verification service.

Suggest Edits

You will have to integrate with 3 APIs to use our In-person KYC Verification service.

  • Schedule In-person KYC Verification API
  • Reschedule In-person KYC Verification API
  • Cancel In-person KYC Verification API

Schedule In-person KYC Verification

You can schedule in-person KYC verification using our APIs.

Use the below endpoint to schedule an in-person KYC request.

POST: https://api.zwitch.io/v1/accounts/{account_id}/schedule-kyc

Below is a sample request and response for a Schedule KYC API

{
  "type": "physical",
  "metadata": {
    "Key_1": "DD",
    "Key_2": "XOF"
  },
  "timeslot": "8am_to_12pm",
  "date": "2022-06-19",
  "merchant_reference_id": "141878618"
}

{
  "id": "fkyc_62J525wvaaZ07yPN2nsXrLg7h",
  "object": "schedule_kyc",
  "awb_number": "5935849091",
  "time_slot": "8am_to_12pm",
  "date": "2022-06-19",
  "merchant_reference_id": "141878618",
  "metadata": {
    "Key_1": "DD",
    "Key_2": "XOF"
  },
  "status": "scheduled",
  "accounts_id": "sa_V49jL7oTcSiESYozi4c092U8t",
  "created_at": 1654693059,
  "is_sandbox": true
}

Learn more about our In-person KYC APIs.

Reschedule In-person KYC Verification

You can reschedule in-person KYC verification using our APIs.

📘

Reschedule Only Once

In-person KYC verification for an account can only be rescheduled once.

To reschedule a verification request that has reached the reschedule limit, cancel the existing request and create a new verification request.

Use the below endpoint to schedule an in-person KYC request.

POST: https://api.zwitch.io/v1/accounts/{account_id}/reschedule-kyc

Below is a sample request and response for a Reschedule KYC API

{
  "timeslot": "12pm_to_4pm",
  "date": "2021-12-31"
}

{
  "id": "fkyc_z2SARmk2QREfywR9VYBfYbAbf",
  "object": "schedule_kyc",
  "awb_number": "6557289335",
  "time_slot": "12pm_to_4pm",
  "date": "2022-07-09",
  "merchant_reference_id": "1001243",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "reschedule_count": 1,
  "status": "scheduled",
  "tracking_details": {
    "message": "Successfully Updated"
  },
  "failure_reason": {},
  "accounts_id": "sa_DfDxREBkBM1lLXZ7mOB0qgHV0",
  "created_at": 1657091298,
  "is_sandbox": true
}

Learn more about our In-person KYC APIs.

Cancel In-person KYC Verification

You can reschedule in-person KYC verification using our APIs.

Use the below endpoint to schedule an in-person KYC request.

POST: https://api.zwitch.io/v1/accounts/{account_id}/schedule-kyc/cancel

Below is a sample response for a Cancel In-person KYC API

{
  "id": "fkyc_z2SARmk2QREfywR9VYBfYbAbf",
  "object": "schedule_kyc",
  "awb_number": "6557289335",
  "time_slot": "12pm_to_4pm",
  "date": "2022-07-09",
  "merchant_reference_id": "1001243",
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "reschedule_count": 1,
  "status": "cancelled",
  "tracking_details": {},
  "failure_reason": {},
  "accounts_id": "sa_DfDxREBkBM1lLXZ7mOB0qgHV0",
  "created_at": 1657091298,
  "is_sandbox": true
}

Learn more about our In-person KYC APIs.

Updated over 1 year ago