UK request examples

To onboard your entity, you can call the Onboard Corporate Customer API. For an example call that you can customize with your information, see:

Private companies

The following is an API request example call where businessType = PRIVATE_COMPANY.

{
    "region": "UK",
    "businessDetails": {
        "businessName": "Bradsons Electronics23",
        "businessRegistrationNumber": "239854510000116",
        "businessType": "PRIVATE_COMPANY",
		"tradeName":"Bradsons Electronics",
		"website":"www.brandsonelectronics.co.uk",
        "addresses": {
            "registeredAddress": {
                "addressLine1": "1 ANGEL COURT, 23RD AVENUE",
                "city": "LONDON",
                "country": "GB",
                "postcode": "EC2R 7AG"
            }
        },
        "legalDetails": {
            "registeredCountry": "GB",
            "registeredDate": "1999-01-02"
        },
        "documentDetails": [
            {
                "documentType": "BUSINESS_REGISTRATION_DOC",
                "document": [
                    {
                        "document": "<Base64 Encoded Document>",
                        "fileName": "BRD.pdf",
                        "fileType": "application/pdf"
                    }
                ]
            }
        ],
        "stakeholders": [
        	{
            
               "stakeholderDetails": {
                    "kycMode": "E_KYC",
                    "firstName": "Bradson",
                    "middleName": "J",
                    "lastName": "Chan",
                    "dateOfBirth": "1980-01-17",
                    "nationality": "GB",
                    "professionalDetails": [
                        {
                            "position": "UBO",
                            "sharePercentage": "5"
                        }
                    ],
                    "address": {
                        "addressLine1": "High Street 303, 24th Street",
                        "addressLine2": "Bradford Avenue",
                        "city": "London",
                        "country": "GB",
                        "postcode": "28046"
                    },
                    "contactDetails": {
                        "contactNo": "691668879",
                        "countryCode": "GB",
                        "email": "[email protected]"
                    },
                    "documentDetails": [
                        {
                            "documentExpiryDate": "2023-09-10",
                            "documentIssuanceCountry": "GB",
                            "documentNumber": "123456009",
                            "documentType": "PASSPORT",
                            "document": [
                                {
                                    "document": "<Base64 Encoded Document>",
                                    "fileName": "passport.pdf",
                                    "fileType": "application/pdf"
                                }
                            ]
                        }
                    ]
                }
            }
            ,
            {
                "stakeholderDetails": {
            "kycMode": "E_KYC",
            "firstName": "BRAD",
            "lastName": "PITT",
            "middleName": "C",
            "nationality": "GB",
            "dateOfBirth": "1985-03-15",
            "professionalDetails": [
                {
                    "position": "DIRECTOR"
                }
            ],
            "address": {
                "addressLine1": "High Street 202",
                "addressLine2": "56th Avenue",
                "city": "London",
                "country": "GB",
                "postcode": "L1 8JQ"
            },
            "contactDetails": {
                "contactNo": "500668880",
                "countryCode": "GB",
                "email": "[email protected]"
            }
                }
            },
            {
                "referenceId": "006ebeeb-3ede-4f49-8381-1e382334131c",
                "businessPartner": {
                    "legalDetails": {
                        "registeredCountry": "FR"
                    },
                    "businessEntityType": "SHAREHOLDER",
                    "businessName": "JumaTECH LIMITED",
                    "businessRegistrationNumber": "JM22843822"
                }
            }

            
        ],
        "applicantDetails": {
            "kycMode": "E_DOC_VERIFY",
            "firstName": "BRAD",
            "lastName": "LEONG",
            "middleName": "C",
            "nationality": "GB",
            "dateOfBirth": "1985-03-15",
            "professionalDetails": [
                {
                    "position": "DIRECTOR"
                }
            ],
            "address": {
                "addressLine1": "High Street 202",
                "addressLine2": "56th Avenue",
                "city": "London",
                "country": "GB",
                "postcode": "L1 8JQ"
            },
            "contactDetails": {
                "contactNo": "500668880",
                "countryCode": "GB",
                "email": "[email protected]"
            }
        },
        "additionalInfo": {
            "isSameBusinessAddress": "Yes",
            "searchId": "h424ad60-1980-wejk-bf27-6crwkce95302d"
        }
    },
    "riskAssessmentInfo": {
        "countryOfOperation": [
            "HK",
            "IN",
            "US"
        ],
        "transactionCountries": [
            "SG",
            "AU",
            "FR"
        ],
        "annualTurnover": "GB005",
        "industrySector": "IS010",
        "intendedUseOfAccount": "IU009",
        "totalEmployees": "EM004"
    },
    "tags": [
        {
            "key": "tag1",
            "value": "tag1value"
        },
        {
            "key": "tag2",
            "value": "tag2value"
        }
    ]
}

Simulate scenarios in the eKYB flow

If you are using the eKYB flow for the UK region, you can generate the following scenarios by using the below steps with the example businessRegistrationNumber (BRN) in the following table.

Request scenarioCondition on BRNExample BRN
Auto-approvalContains M01M01324536, 234M01456, 12M01B325
Action requiredContains B02B02324536, 234B02456, 12B02B325
In Progress with documents requiredContains B03B03324536, 234B03456, 12B03B325
Completing applicant eDocVerifyPattern on applicantDetails.contactDetails.contactNo

Step 1: Call the Public Corporate Details using Business ID API using the Business Registration Number and Region according to the scenario you want to test. You receive multiple businesses in the response. Pick the one with the matching businessRegistrationNumber and copy the searchReferenceId.

In this response, the businessName is always returned as NIUM FINTECH PRIVATE LIMITED for any of the businessRegistrationNumber mentioned in the table and doesn't match with what is returned in Step 2. This behavior is only in the sandbox; the accurate name appears in production.

Step 2: Call the Exhaustive Corporate Details using Business ID API using the searchReferenceId received in Step 1 for the particular scenario. This returns detailed information about the corporate customer including searchId.

Step 3: Use the example requests in the table and call the Onboard Corporate Customer API.

Step 4: Use the redirect URL and complete the Applicant KYC section on the Onfido page (or use the KYC simulation below) and wait for the webhook. Verification can be completed with dummy credentials if using Onfido's sandbox. Regardless, you need to open the redirect URL in a separate browser tab.

Response conditions for the Exhaustive Corporate Details API

You can generate responses for different businessType entities by following the table below. This can be used for testing the pre-population flow after calling the Exhaustive Corporate Details Using Business ID API.

businessTypebusinessRegistrationNumber condition
PRIVATE_LIMITED_COMPANYContains B01 or B02 or B03
PUBLIC_COMPANYContains B11 or B12 or B13
SOLE_TRADERContains B21 or B22 or B23
GOVERNMENT_BODYContains B31 or B32 or B33
TRUSTContains B41 or B42 or B43
LIMITED_LIABILITY_PARTNERSHIPContains B51 or B52 or B53
ASSOCIATIONContains B61 or B62 or B63

Request example: auto-approval

In this scenario, all documents and information required for completing the verification process are provided in the Onboard Corporate Customer API. The application is approved in real-time (within a few minutes) and then you receive a webhook with status='COMPLETED'. This is applicable only for the eKYB flow.

{
    "region": "UK",
    "businessDetails": {
        "businessName": "HEATHER COMPANY mgmra",
        "businessRegistrationNumber": "GBB01834733",
        "website": null,
        "tradeName": "HEATHER COMPANY",
        "businessType": "PRIVATE_COMPANY",
        "legalDetails": {
            "registeredCountry": "GB",
            "registeredDate": "2016-01-17"
        },
        "addresses": {
            "registeredAddress": {
                "addressLine1": "44-137 BRADFORD STREET",
                "addressLine2": "CONVENT GARDEN",
                "city": "LONDON",
                "state": null,
                "country": "GB",
                "postcode": "SO53 2FW"
            }
        },
        "stakeholders": [
            {
                "entityType": "CORPORATE",
                "stakeholderDetails": null,
                "businessPartner": {
                    "businessName": "ACME PVT. LTD.",
                    "businessRegistrationNumber": "P652246613",
                    "businessEntityType": "UBO",
                    "sharePercentage": "4.00",
                    "addresses": {
                        "registeredAddress": null,
                        "businessAddress": null
                    },
                    "legalDetails": {
                        "registeredCountry": "GB",
                        "registeredDate": "2016-01-17"
                    }
                }
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MARTHA",
                    "middleName": null,
                    "lastName": "ROGERS djkfs",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "SHAREHOLDER",
                            "sharePercentage": "27.00"
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
             {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MD",
                    "middleName": null,
                    "lastName": "AKRAM HOSSAIN kdsci",
                    "kycMode": "E_KYC",
                    "nationality": "BD",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "UBO",
                            "sharePercentage": "27.00"
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "ARTHUR",
                    "middleName": null,
                    "lastName": "ROGERS vateu",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "DIRECTOR",
                            "sharePercentage": null
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MARY",
                    "middleName": null,
                    "lastName": "ROGERS ktbck",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "DIRECTOR",
                            "sharePercentage": null
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            }
        ],
        "additionalInfo": {
            "searchId": "31c1a330-7b6c-4e17-9da9-a99ab29d92d8",
            "isSameBusinessAddress": "Yes"
        },
        "applicantDetails": {
            "firstName": "MARY",
            "middleName": null,
            "lastName": "ROGERS ktbcwe",
            "kycMode": "E_DOC_VERIFY",
            "nationality": "GB",
            "dateOfBirth": "1992-10-10",
            "address": {
                "addressLine1": "13 Hursley Road Chandlers Ford",
                "addressLine2": null,
                "city": "Vilnius",
                "state": null,
                "country": "LT",
                "postcode": "LT-8098"
            },
            "contactDetails": {
                "email": "[email protected]",
                "contactNo": "442020757588",
                "countryCode": "GB"
            },
            "professionalDetails": [
                {
                    "position": "DIRECTOR",
                    "sharePercentage": null
                }
            ],
            "documentDetails": null
        }
    },
    "riskAssessmentInfo": {
        "totalEmployees": "EM005",
        "annualTurnover": "GB007",
        "countryOfOperation": [
            "GB"
        ],
        "industrySector": "IS010",
        "intendedUseOfAccount": "IU003",
        "travelRestrictedCountry": "Yes",
        "transactionCountries": [
            "GB"
        ],
        "restrictedCountries": [
            "SG"
        ],
        "ofacLicencePresent": "Yes"
    }
}

Request example: action required

In this scenario, all the documents and information required are provided in the Onboard Corporate Customer API, but the application was not auto-approved and needs to be manually reviewed by Nium's compliance team. You receive a webhook with status='ACTION_REQUIRED' . Once received, wait for the next webhook which will be sent once the compliance agent completes the manual review.

{
    "region": "UK",
    "businessDetails": {
        "businessName": "HEATHER COMPANY waoek",
        "businessRegistrationNumber": "GBB02834733",
        "website": null,
        "tradeName": "HEATHER COMPANY",
        "businessType": "PRIVATE_COMPANY",
        "legalDetails": {
            "registeredCountry": "GB",
            "registeredDate": "2016-01-17"
        },
        "addresses": {
            "registeredAddress": {
                "addressLine1": "44-137 BRADFORD STREET",
                "addressLine2": "CONVENT GARDEN",
                "city": "LONDON",
                "state": null,
                "country": "GB",
                "postcode": "SO53 2FW"
            }
        },
        "stakeholders": [
            {
                "entityType": "CORPORATE",
                "stakeholderDetails": null,
                "businessPartner": {
                    "businessName": "ACME PVT. LTD.",
                    "businessRegistrationNumber": "P652246613",
                    "businessEntityType": "UBO",
                    "sharePercentage": "4.00",
                    "addresses": {
                        "registeredAddress": null,
                        "businessAddress": null
                    },
                    "legalDetails": {
                        "registeredCountry": "GB",
                        "registeredDate": "2016-01-17"
                    }
                }
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MARTHA",
                    "middleName": null,
                    "lastName": "ROGERS dqhfj",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "SHAREHOLDER",
                            "sharePercentage": "27.00"
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "ARTHUR",
                    "middleName": null,
                    "lastName": "ROGERS bamqe",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "DIRECTOR",
                            "sharePercentage": null
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MARY",
                    "middleName": null,
                    "lastName": "ROGERS vmikg",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "DIRECTOR",
                            "sharePercentage": null
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            }
        ],
        "additionalInfo": {
            "searchId": "1970b00a-229f-49bf-8c68-f45f600b98b0",
            "isSameBusinessAddress": "Yes"
        },
        "applicantDetails": {
            "firstName": "MARY",
            "middleName": null,
            "lastName": "ROGERS ktsdwe",
            "kycMode": "E_DOC_VERIFY",
            "nationality": "GB",
            "dateOfBirth": "1992-10-10",
            "address": {
                "addressLine1": "13 Hursley Road Chandlers Ford",
                "addressLine2": null,
                "city": "Vilnius",
                "state": null,
                "country": "LT",
                "postcode": "LT-8098"
            },
            "contactDetails": {
                "email": "[email protected]",
                "contactNo": "442020757588",
                "countryCode": "GB"
            },
            "professionalDetails": [
                {
                    "position": "DIRECTOR",
                    "sharePercentage": null
                }
            ],
            "documentDetails": null
        }
    },
    "riskAssessmentInfo": {
        "totalEmployees": "EM005",
        "annualTurnover": "GB007",
        "countryOfOperation": [
            "GB"
        ],
        "industrySector": "IS010",
        "intendedUseOfAccount": "IU003",
        "travelRestrictedCountry": "Yes",
        "transactionCountries": [
            "GB"
        ],
        "restrictedCountries": [
            "SG"
        ],
        "ofacLicencePresent": "Yes"
    }
}

Request example: In Progress with documents required

In this scenario, all information required for completing the verification process is provided in the Onboard Corporate Customer API, however some of the required documents are not submitted. The customer is expected to submit all the required documents after which Nium initiates the verification. In this case, you need to receive the documents required in the remarks field.

{
    "region": "UK",
    "businessDetails": {
        "businessName": "HEATHER COMPANY xdmbl",
        "businessRegistrationNumber": "B0183473323",
        "website": null,
        "tradeName": "HEATHER COMPANY",
        "businessType": "PRIVATE_COMPANY",
        "legalDetails": {
            "registeredCountry": "GB",
            "registeredDate": "2016-01-17"
        },
        "addresses": {
            "registeredAddress": {
                "addressLine1": "44-137 BRADFORD STREET",
                "addressLine2": "CONVENT GARDEN",
                "city": "LONDON",
                "state": null,
                "country": "GB",
                "postcode": "SO53 2FW"
            }
        },
        "stakeholders": [
            {
                "entityType": "CORPORATE",
                "stakeholderDetails": null,
                "businessPartner": {
                    "businessName": "ACME PVT. LTD.",
                    "businessRegistrationNumber": "P652246613",
                    "businessEntityType": "UBO",
                    "sharePercentage": "4.00",
                    "addresses": {
                        "registeredAddress": null,
                        "businessAddress": null
                    },
                    "legalDetails": {
                        "registeredCountry": "GB",
                        "registeredDate": "2016-01-17"
                    }
                }
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MARTHA",
                    "middleName": null,
                    "lastName": "ROGERS vsvrn",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "SHAREHOLDER",
                            "sharePercentage": "27.00"
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
             {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MD",
                    "middleName": null,
                    "lastName": "AKRAM HOSSAIN ckocb",
                    "kycMode": "E_KYC",
                    "nationality": "BD",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "UBO",
                            "sharePercentage": "27.00"
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "ARTHUR",
                    "middleName": null,
                    "lastName": "ROGERS odkox",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "DIRECTOR",
                            "sharePercentage": null
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            },
            {
                "entityType": "INDIVIDUAL",
                "stakeholderDetails": {
                    "firstName": "MARY",
                    "middleName": null,
                    "lastName": "ROGERS ixiup",
                    "kycMode": "E_KYC",
                    "nationality": "GB",
                    "dateOfBirth": "1992-10-10",
                    "address": {
                        "addressLine1": "13 Hursley Road Chandlers Ford",
                        "addressLine2": null,
                        "city": "Vilnius",
                        "state": null,
                        "country": "LT",
                        "postcode": "LT-8098"
                    },
                    "contactDetails": {
                        "email": "[email protected]",
                        "contactNo": "442020757588",
                        "countryCode": null
                    },
                    "professionalDetails": [
                        {
                            "position": "DIRECTOR",
                            "sharePercentage": null
                        }
                    ],
                    "documentDetails": null
                },
                "businessPartner": null
            }
        ],
        "additionalInfo": {
            "searchId": "65d23e6e-221b-4caf-bb02-56d527cb78b1",
            "isSameBusinessAddress": "Yes"
        },
        "applicantDetails": {
            "firstName": "MARY",
            "middleName": null,
            "lastName": "ROGERS ktbcwe",
            "kycMode": "E_DOC_VERIFY",
            "nationality": "GB",
            "dateOfBirth": "1992-10-10",
            "address": {
                "addressLine1": "13 Hursley Road Chandlers Ford",
                "addressLine2": null,
                "city": "Vilnius",
                "state": null,
                "country": "LT",
                "postcode": "LT-8098"
            },
            "contactDetails": {
                "email": "[email protected]",
                "contactNo": "442020757588",
                "countryCode": "GB"
            },
            "professionalDetails": [
                {
                    "position": "REPRESENTATIVE",
                    "sharePercentage": null
                }
            ],
            "documentDetails": null
        }
    },
    "riskAssessmentInfo": {
        "totalEmployees": "EM005",
        "annualTurnover": "GB007",
        "countryOfOperation": [
            "GB"
        ],
        "industrySector": "IS010",
        "intendedUseOfAccount": "IU003",
        "travelRestrictedCountry": "Yes",
        "transactionCountries": [
            "GB"
        ],
        "restrictedCountries": [
            "SG"
        ],
        "ofacLicencePresent": "Yes"
    }
}

Completing applicant eKYC

For UK residents, the applicant eKYC is done via MyInfo.

To simulate different success and error responses of the eKYC flow, use the following conditions on the applicant's phone number. In all cases, the applicant needs to open the redirectURL in their browser. You either land on the vendor’s page or receive a success/failure redirection back to your client KYC redirect URL without any actions needed on the UI. The redirectURL has isSuccess, errorCode, and errorMessage parameters as described in Applicant KYC.

Based on businessDetails.applicantDetails.contactDetail.contactNumber, there are two outcomes:

First two digits of contactNumberResulting situation
Doesn't contain any of the simulated patternsMyinfo’s sandbox page is opened and the applicant needs to complete the simulated authentication on the UI. This can be used for end-to-end testing.
Does contain any of the simulated patternsThe customer's browser redirects to your KYC redirect URL without the need of any actions on the UI. Redirection will contain the following Redirection parameters

Redirection parameters

Return codeQuery parameters in the redirection
91isSuccess = true ; errorCode =; errorMessage =

Opening the redirect URL twice will generate the verification already completed scenario:

isSuccess = false ; errorCode =; errorMessage=verificationAlreadyCompleted
71isSuccess = false ; errorCode = I400; errorMessage = vendorValidationError
21isSuccess = false; errorCode = R500; errorMessage = internalServerError