diff --git a/v0/catalog/knowyourcustomer/kyc_match_openapi.yaml b/v0/catalog/knowyourcustomer/kyc_match_openapi.yaml index 45247d4..cc019ef 100644 --- a/v0/catalog/knowyourcustomer/kyc_match_openapi.yaml +++ b/v0/catalog/knowyourcustomer/kyc_match_openapi.yaml @@ -39,6 +39,13 @@ paths: Create an app on our [Sandbox](/docs/sandbox) to get credentials and [retrieve tokens](/reference/authorize) so you can perform API calls to our operators' production environments, or use the following convenience token to test in mock mode: `mock_sandbox_access_token` + + ## Mock Mode Technical Specification + + When testing in mock mode, the following rules apply based on the input: + + - If the input is invalid → the response is 400 Bad Request with details of the invalid field. + - If the input is valid → the response is 200 OK with `match: true/false` and `matchScore` between 0 and 100 for some keys. operationId: KYC_Match_v0.2 security: diff --git a/v0/catalog/numberverification/numberverification_openapi.yaml b/v0/catalog/numberverification/numberverification_openapi.yaml index 19f8f52..768bd2b 100644 --- a/v0/catalog/numberverification/numberverification_openapi.yaml +++ b/v0/catalog/numberverification/numberverification_openapi.yaml @@ -59,6 +59,14 @@ paths: `mock_sandbox_access_token` + ## Mock Mode Technical Specification + + When testing in mock mode, the following rules apply based on the phone number: + + - If `phoneNumber` ends with 1 → the response is 200 OK with `devicePhoneNumberVerified: true`. + - If `phoneNumber` ends with 2 → the response is 200 OK with `devicePhoneNumberVerified: false`. + - If `phoneNumber` ends with 3-0 → the response is 200 OK and `devicePhoneNumberVerified` will be true or false depending on whether the current timestamp is even or odd. + You can explore our [Number Verification sample code](/docs/samplecode_numberverification) for additional guidance on using this API. operationId: phoneNumberVerify requestBody: diff --git a/v0/catalog/simswap/simswap_openapi.yaml b/v0/catalog/simswap/simswap_openapi.yaml index c06cfd3..c706114 100644 --- a/v0/catalog/simswap/simswap_openapi.yaml +++ b/v0/catalog/simswap/simswap_openapi.yaml @@ -50,6 +50,16 @@ paths: `mock_sandbox_access_token` + ## Mock Mode Technical Specification + + When testing in mock mode, the following rules apply based on the phone number: + + - If `phoneNumber` ends with 1 → the response is 200 OK with `simSwapped: true`. + - If `phoneNumber` ends with 2 → the response is 200 OK with `simSwapped: false`. + - If `phoneNumber` ends with 3-0 → the response is 200 OK and `simSwapped` will be true or false depending on whether the current timestamp is even or odd. + - When retrieving swap date: if `phoneNumber` ends with 9 → the response is 409 Conflict with message: "Another request is created for the same phone number". + - When retrieving swap date: if `phoneNumber` ends with 0-8 → the response is 200 OK with `latestSimChange` timestamp. + You can explore our [SIM Swap sample code](/docs/samplecode_simswap) for additional guidance on using this API. operationId: checkSimSwap requestBody: @@ -102,6 +112,16 @@ paths: `mock_sandbox_access_token` + ## Mock Mode Technical Specification + + When testing in mock mode, the following rules apply based on the phone number: + + - If `phoneNumber` ends with 1 → the response is 200 OK with `simSwapped: true`. + - If `phoneNumber` ends with 2 → the response is 200 OK with `simSwapped: false`. + - If `phoneNumber` ends with 3-0 → the response is 200 OK and `simSwapped` will be true or false depending on whether the current timestamp is even or odd. + - When retrieving swap date: if `phoneNumber` ends with 9 → the response is 409 Conflict with message: "Another request is created for the same phone number". + - When retrieving swap date: if `phoneNumber` ends with 0-8 → the response is 200 OK with `latestSimChange` timestamp. + You can explore our [SIM Swap sample code](/docs/samplecode_simswap) for additional guidance on using this API. operationId: retrieveSimSwapDate requestBody: