Handling deferred ID collection RFIs

Native API integration for liveness check is the recommended integration option when a platform wants to defer identification verification until the threshold limit is reached. For more information, see Deferred identity verification.

Before you begin

• Your connected accounts must be onboarded to your platform using the Native API integration.
• You must have an access token to make API calls. See Obtain your access token API.
• Deferred identity verification must be enabled for your platform account. Contact your Account Manager if it isn’t already enabled.
• You must be integrated with KYC RFI Native API.
• You must be subscribed to RFI webhook events.

Step 1: Retrieve the liveness URL from the RFI

Subscribe to the rfi.action_required webhook event. When you receive the webhook notification, call Retrieve an RFI API and fetch the liveness.url from the response. Generate a QR code based on the liveness URL and present it to the user.

Example request

Shell
1curl --request GET
2--url 'https://api-demo.airwallex.com/api/v1/rfis/a72f3483-d600-4d9a-a051-bcbe5126a4b4'
3--header 'Authorization: Bearer <your_bearer_token>'

Example response

JSON
1{
2    "account_id": "acct_5si2VM3ONWKRSqCnKFIMxg",
3    "active_request": {
4        "created_at": "2024-11-27T10:00:32+0000",
5        "questions": [
6            {
7                "answer": {
8                    "type": "LIVENESS"
9                },
10                "attachments": [],
11                "description": {
12                    "en": "Liveness verification is required for John Smith. Please ensure that this person receives the URL below with instructions to open it on their mobile device.  \n\nThey will need an ID or passport and a working camera on their device.  \n\nhttps://demo.airwallex.com/liveness/rfi?id=994ec028-ff1d-4306-8cc4-84e12a7c8e92&itemId=091a5e14-0d9d-4fad-939e-8d45dfad017d&accountId=bdc35a3a-2f81-4500-b882-dc21e7187cf7&locale=en&dc=sg",
13                    "zh": "John Smith需要进行身份核验。请确保此用户收到以下链接，并在移动设备上打开链接进行验证。  \n\n用户需要准备身份证或护照，并确保摄像头正常工作。  \n\nhttps://demo.airwallex.com/liveness/rfi?id=994ec028-ff1d-4306-8cc4-84e12a7c8e92&itemId=091a5e14-0d9d-4fad-939e-8d45dfad017d&accountId=bdc35a3a-2f81-4500-b882-dc21e7187cf7&locale=en&dc=sg"
14                },
15                "id": "a62b97df-c4ba-496e-bd9e-1b7ccc81131c",
16                "liveness": {
17                    "status": "NOT_STARTED",
18                    "url": "https://staging.airwallex.com/liveness/rfi?id=6c1edef0-2461-4e00-b8d8-be470a6529c5&itemId=aa41b5d6-0058-4e07-9a2f-f920deb6859b&accountId=bdc35a3a-2f81-4500-b882-dc21e7187cf7&locale=en&dc=sg"
19                },
20                "sources": [
21                    {
22                        "id": "e01c7711-a3c7-48a2-8942-3e7fe2d58a1f",
23                        "person": {
24                            "first_name": "John",
25                            "last_name": "Smith"
26                        },
27                        "type": "PERSON"
28                    }
29                ],
30                "title": {
31                    "en": "Personal ID Verification ",
32                    "zh": "人脸识别核验"
33                }
34            }
35        ],
36        "updated_at": "2024-11-27T10:00:32+0000"
37    },
38    "answered_requests": [],
39    "created_at": "2024-11-27T10:00:32+0000",
40    "id": "d10b4e1f-2315-4224-9ae9-5064750feb06",
41    "status": "ACTION_REQUIRED",
42    "type": "KYC",
43    "updated_at": "2024-11-27T10:00:32+0000"
44}

Step 2: Respond to the RFI questions

After the user completes the liveness verification on their mobile device, you may encounter one of the following scenarios:

• RFI includes only LIVENESS questions: Skip calling Respond to an RFI API because Airwallex resolves the question automatically after successful verification.
• RFI includes both LIVENESS and other questions: Wait until the liveness verification completes, then call Respond to an RFI API to answer the remaining questions.

The rfi.answered webhook notification indicates that the liveness verification is complete. You will receive the rfi.closed webhook after Airwallex reviews and closes the RFI.