Request for Information (RFI)
Simulate the creation and closure of RFI in the sandbox environment.
POST /api/v1/simulation/rfis/createPOST /api/v1/simulation/rfis/{id}/follow_upPOST /api/v1/simulation/rfis/{id}/close
Create an RFI
POST /api/v1/simulation/rfis/create
Use this endpoint to create an RFI for specific type.
The questions and related sources are simulated.
All RFIs for specified type must be in CLOSED status.
The questions in this RFI.
Expected response to the question
The expected type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
In the case where a question is linked to a specific source (such as a cardholder) then the source should be specified.
Unique identifier for the source
The type of the source. Valid values depend on the RFI type::
KYC/KYC_ONGOING:PERSONCARDHOLDER:CARDHOLDERMERCHANT_RISK:PAYMENT_INTENTTRANSACTION:CHARGE,CONNECTED_ACCOUNT_TRANSFER,DIRECT_DEBIT,DEPOSIT,TRANSFER
The type of RFI. Currently supports KYC, KYC_ONGOING, CARDHOLDER, TRANSACTION, PAYMENT_ENABLEMENT and MERCHANT_RISK types.
Airwallex account unique identifier
The current RFI request you are required to respond to
Timestamp the RFI request was created
Timestamp the RFI request will expire, and the RFI status will be transited to CLOSED.
List of questions
Response to the question
Response for ADDRESS type
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Response for ATTACHMENT type
File id provided in the response from the File Service API
comment for this response
Response for CONFIRMATION type
Response for IDENTITY_DOCUMENT type
File id of the photo of the back of the document.
File id of the photo of the front of the document.
Country issuing the document. (2-letter ISO 3166-2 country code)
Identity number.
Type of identity document. One of DRIVING_LICENSE,PASSPORT,IDENTITY_CARD,MEDICARE_CARD,SSN,ITIN
Response for TEXT type
The type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
The supporting documents of the question.
File id used in File Service API to get file download link
Additional description for this question
The description of the question.
Content in English
Content in Chinese
Unique identifier for the question.
The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements
Possible values:
PROOF_OF_ADDRESSID_COPY
Information for the LIVENESS type questions
The status of the liveness verification
FAILED, NOT_STARTED, STARTED, SUBMITTED, SUCCEEDED
This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera.
Please note:
- If
LIVENESSis the only question in the RFI, theRespond to an RFIAPI does not need a separate call. It will be auto-resolved after verification. - For RFIs with both
LIVENESSand other questions, please complete liveness verification before responding to the rest.
In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified
Unique identifier for the source
Information for PERSON source
First name of the person
Last name of the person
The type of the source. Type of values and their corresponding API:
-
PERSON: Get account by ID -
BUSINESS: matchaccount_details.business_person_details.person_idwith the source id -
INDIVIDUAL: matchaccount_details.individual_details.person_idwith the source id -
If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.
-
CARDHOLDER: Get cardholder details -
PAYMENT_INTENT: Retrieve a PaymentIntent
For TRANSACTION RFI:
CHARGE: Get a charge by IDTRANSFER: Get a transfer by IDDIRECT_DEBIT: Get direct debit by IDDEPOSIT: Get a deposit by IDPAYMENT: Get payment by ID
The title of the question.
Content in English
Content in Chinese
The uploaded orders which are related to the transaction, only applicable for TRANSACTION RFI.
Unique identifier of the uploaded order.
The latest timestamp the RFI request was updated
The list of RFI requests that have already been responded to
Timestamp the RFI request was created
Timestamp the RFI request will expire, and the RFI status will be transited to CLOSED.
List of questions
Response to the question
Response for ADDRESS type
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Response for ATTACHMENT type
File id provided in the response from the File Service API
comment for this response
Response for CONFIRMATION type
Response for IDENTITY_DOCUMENT type
File id of the photo of the back of the document.
File id of the photo of the front of the document.
Country issuing the document. (2-letter ISO 3166-2 country code)
Identity number.
Type of identity document. One of DRIVING_LICENSE,PASSPORT,IDENTITY_CARD,MEDICARE_CARD,SSN,ITIN
Response for TEXT type
The type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
The supporting documents of the question.
File id used in File Service API to get file download link
Additional description for this question
The description of the question.
Content in English
Content in Chinese
Unique identifier for the question.
The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements
Possible values:
PROOF_OF_ADDRESSID_COPY
Information for the LIVENESS type questions
The status of the liveness verification
FAILED, NOT_STARTED, STARTED, SUBMITTED, SUCCEEDED
This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera.
Please note:
- If
LIVENESSis the only question in the RFI, theRespond to an RFIAPI does not need a separate call. It will be auto-resolved after verification. - For RFIs with both
LIVENESSand other questions, please complete liveness verification before responding to the rest.
In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified
Unique identifier for the source
Information for PERSON source
First name of the person
Last name of the person
The type of the source. Type of values and their corresponding API:
-
PERSON: Get account by ID -
BUSINESS: matchaccount_details.business_person_details.person_idwith the source id -
INDIVIDUAL: matchaccount_details.individual_details.person_idwith the source id -
If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.
-
CARDHOLDER: Get cardholder details -
PAYMENT_INTENT: Retrieve a PaymentIntent
For TRANSACTION RFI:
CHARGE: Get a charge by IDTRANSFER: Get a transfer by IDDIRECT_DEBIT: Get direct debit by IDDEPOSIT: Get a deposit by IDPAYMENT: Get payment by ID
The title of the question.
Content in English
Content in Chinese
The uploaded orders which are related to the transaction, only applicable for TRANSACTION RFI.
Unique identifier of the uploaded order.
The latest timestamp the RFI request was updated
Timestamp the RFI was created
Unique identifier for the RFI
The status of the RFI. Possible values:
ACTION_REQUIRED: Airwallex requires you to respond to the RFI requestANSWERED: You have already responded to the RFI request and your response is being reviewed by AirwallexCLOSED: The review is complete and no further information is required
The sub type of RFI.
For TRANSACTION RFI:
TRANSACTION_MONITORING: Internal transaction monitoringTRANSACTION_SCREENING: Internal transaction screeningBANKING_PARTNER_INQUIRY: External banking partner inquiry
The type of RFI. Currently supports KYC, KYC_ONGOING, CARDHOLDER, TRANSACTION, PAYMENT_ENABLEMENT and MERCHANT_RISK types.
The latest timestamp the RFI was updated
| Error status | Description |
|---|---|
| 400 | invalid_argument |
| 401 | credentials_invalid |
| 500 | service_unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/simulation/rfis/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "questions": [> {> "answer": {> "type": "TEXT"> },> "sources": [> {> "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",> "type": "TRANSFER"> }> ]> }> ],> "type": "KYC">}'
1{2 "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg",3 "active_request": {4 "created_at": "2023-04-12T07:29:36+0000",5 "expires_at": "2023-04-19T07:29:36+0000",6 "questions": [7 {8 "answer": {9 "address": {10 "address_line1": "200 Collins Street",11 "address_line2": "200 Collins Street",12 "country_code": "AU",13 "postcode": "3000",14 "state": "VIC",15 "suburb": "Melbourne"16 },17 "attachments": [18 {19 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"20 }21 ],22 "identity_document": {23 "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",24 "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",25 "issuing_country": "AU",26 "number": "123456789",27 "type": "DRIVING_LICENSE"28 },29 "type": "TEXT"30 },31 "attachments": [32 {33 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"34 }35 ],36 "comment": "Please provide more information",37 "description": {38 "en": "Information confirmation",39 "zh": "信息确认"40 },41 "id": "ba7bfb51-77bc-4991-b651-0969ece1d263",42 "key": "PROOF_OF_ADDRESS",43 "liveness": {44 "status": "NOT_STARTED"45 },46 "sources": [47 {48 "id": "318ce9e9-c370-42bd-8192-e78283770c43",49 "person": {50 "first_name": "John",51 "last_name": "Smith"52 },53 "type": "CARDHOLDER"54 }55 ],56 "title": {57 "en": "Information confirmation",58 "zh": "信息确认"59 },60 "uploaded_orders": [61 {62 "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec"63 }64 ]65 }66 ],67 "updated_at": "2023-04-14T07:29:36+0000"68 },69 "answered_requests": [70 {71 "created_at": "2023-04-12T07:29:36+0000",72 "expires_at": "2023-04-19T07:29:36+0000",73 "questions": [74 {75 "answer": {76 "address": {77 "address_line1": "200 Collins Street",78 "address_line2": "200 Collins Street",79 "country_code": "AU",80 "postcode": "3000",81 "state": "VIC",82 "suburb": "Melbourne"83 },84 "attachments": [85 {86 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"87 }88 ],89 "identity_document": {90 "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",91 "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",92 "issuing_country": "AU",93 "number": "123456789",94 "type": "DRIVING_LICENSE"95 },96 "type": "TEXT"97 },98 "attachments": [99 {100 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"101 }102 ],103 "comment": "Please provide more information",104 "description": {105 "en": "Information confirmation",106 "zh": "信息确认"107 },108 "id": "ba7bfb51-77bc-4991-b651-0969ece1d263",109 "key": "PROOF_OF_ADDRESS",110 "liveness": {111 "status": "NOT_STARTED"112 },113 "sources": [114 {115 "id": "318ce9e9-c370-42bd-8192-e78283770c43",116 "person": {117 "first_name": "John",118 "last_name": "Smith"119 },120 "type": "CARDHOLDER"121 }122 ],123 "title": {124 "en": "Information confirmation",125 "zh": "信息确认"126 },127 "uploaded_orders": [128 {129 "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec"130 }131 ]132 }133 ],134 "updated_at": "2023-04-14T07:29:36+0000"135 }136 ],137 "created_at": "2023-04-11T07:29:36+0000",138 "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92",139 "status": "ACTION_REQUIRED",140 "sub_type": "TRANSACTION_MONITORING",141 "type": "KYC",142 "updated_at": "2023-04-12T07:29:36+0000"143}
Follow-up RFI
POST /api/v1/simulation/rfis/{id}/follow_up
Use this endpoint to create a follow-up on an existing RFI. You can choose to retain the existing questions, append new ones, or both, depending on your testing needs.
Unique identifier of the RFI
The questions in this RFI. You can refer to an existing question by its unique identifier, or append new questions by specifying the expected response type.
Expected response to the question, this is required if id is not passed.
The expected type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
Unique identifier of the original RFI question, which will be reopened by this follow-up request.
In the case where a question is linked to a specific source (such as a cardholder) then the source should be specified.
Unique identifier for the source
The type of the source. Valid values depend on the RFI type::
KYC/KYC_ONGOING:PERSONCARDHOLDER:CARDHOLDERMERCHANT_RISK:PAYMENT_INTENTTRANSACTION:CHARGE,CONNECTED_ACCOUNT_TRANSFER,DIRECT_DEBIT,DEPOSIT,TRANSFER
Airwallex account unique identifier
The current RFI request you are required to respond to
Timestamp the RFI request was created
Timestamp the RFI request will expire, and the RFI status will be transited to CLOSED.
List of questions
Response to the question
Response for ADDRESS type
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Response for ATTACHMENT type
File id provided in the response from the File Service API
comment for this response
Response for CONFIRMATION type
Response for IDENTITY_DOCUMENT type
File id of the photo of the back of the document.
File id of the photo of the front of the document.
Country issuing the document. (2-letter ISO 3166-2 country code)
Identity number.
Type of identity document. One of DRIVING_LICENSE,PASSPORT,IDENTITY_CARD,MEDICARE_CARD,SSN,ITIN
Response for TEXT type
The type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
The supporting documents of the question.
File id used in File Service API to get file download link
Additional description for this question
The description of the question.
Content in English
Content in Chinese
Unique identifier for the question.
The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements
Possible values:
PROOF_OF_ADDRESSID_COPY
Information for the LIVENESS type questions
The status of the liveness verification
FAILED, NOT_STARTED, STARTED, SUBMITTED, SUCCEEDED
This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera.
Please note:
- If
LIVENESSis the only question in the RFI, theRespond to an RFIAPI does not need a separate call. It will be auto-resolved after verification. - For RFIs with both
LIVENESSand other questions, please complete liveness verification before responding to the rest.
In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified
Unique identifier for the source
Information for PERSON source
First name of the person
Last name of the person
The type of the source. Type of values and their corresponding API:
-
PERSON: Get account by ID -
BUSINESS: matchaccount_details.business_person_details.person_idwith the source id -
INDIVIDUAL: matchaccount_details.individual_details.person_idwith the source id -
If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.
-
CARDHOLDER: Get cardholder details -
PAYMENT_INTENT: Retrieve a PaymentIntent
For TRANSACTION RFI:
CHARGE: Get a charge by IDTRANSFER: Get a transfer by IDDIRECT_DEBIT: Get direct debit by IDDEPOSIT: Get a deposit by IDPAYMENT: Get payment by ID
The title of the question.
Content in English
Content in Chinese
The uploaded orders which are related to the transaction, only applicable for TRANSACTION RFI.
Unique identifier of the uploaded order.
The latest timestamp the RFI request was updated
The list of RFI requests that have already been responded to
Timestamp the RFI request was created
Timestamp the RFI request will expire, and the RFI status will be transited to CLOSED.
List of questions
Response to the question
Response for ADDRESS type
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Response for ATTACHMENT type
File id provided in the response from the File Service API
comment for this response
Response for CONFIRMATION type
Response for IDENTITY_DOCUMENT type
File id of the photo of the back of the document.
File id of the photo of the front of the document.
Country issuing the document. (2-letter ISO 3166-2 country code)
Identity number.
Type of identity document. One of DRIVING_LICENSE,PASSPORT,IDENTITY_CARD,MEDICARE_CARD,SSN,ITIN
Response for TEXT type
The type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
The supporting documents of the question.
File id used in File Service API to get file download link
Additional description for this question
The description of the question.
Content in English
Content in Chinese
Unique identifier for the question.
The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements
Possible values:
PROOF_OF_ADDRESSID_COPY
Information for the LIVENESS type questions
The status of the liveness verification
FAILED, NOT_STARTED, STARTED, SUBMITTED, SUCCEEDED
This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera.
Please note:
- If
LIVENESSis the only question in the RFI, theRespond to an RFIAPI does not need a separate call. It will be auto-resolved after verification. - For RFIs with both
LIVENESSand other questions, please complete liveness verification before responding to the rest.
In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified
Unique identifier for the source
Information for PERSON source
First name of the person
Last name of the person
The type of the source. Type of values and their corresponding API:
-
PERSON: Get account by ID -
BUSINESS: matchaccount_details.business_person_details.person_idwith the source id -
INDIVIDUAL: matchaccount_details.individual_details.person_idwith the source id -
If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.
-
CARDHOLDER: Get cardholder details -
PAYMENT_INTENT: Retrieve a PaymentIntent
For TRANSACTION RFI:
CHARGE: Get a charge by IDTRANSFER: Get a transfer by IDDIRECT_DEBIT: Get direct debit by IDDEPOSIT: Get a deposit by IDPAYMENT: Get payment by ID
The title of the question.
Content in English
Content in Chinese
The uploaded orders which are related to the transaction, only applicable for TRANSACTION RFI.
Unique identifier of the uploaded order.
The latest timestamp the RFI request was updated
Timestamp the RFI was created
Unique identifier for the RFI
The status of the RFI. Possible values:
ACTION_REQUIRED: Airwallex requires you to respond to the RFI requestANSWERED: You have already responded to the RFI request and your response is being reviewed by AirwallexCLOSED: The review is complete and no further information is required
The sub type of RFI.
For TRANSACTION RFI:
TRANSACTION_MONITORING: Internal transaction monitoringTRANSACTION_SCREENING: Internal transaction screeningBANKING_PARTNER_INQUIRY: External banking partner inquiry
The type of RFI. Currently supports KYC, KYC_ONGOING, CARDHOLDER, TRANSACTION, PAYMENT_ENABLEMENT and MERCHANT_RISK types.
The latest timestamp the RFI was updated
| Error status | Description |
|---|---|
| 400 | invalid_argument |
| 401 | credentials_invalid |
| 404 | not_found |
| 500 | service_unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/simulation/rfis/request_for_information_rfi_id/follow_up' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "questions": [> {> "answer": {> "type": "TEXT"> },> "id": "6f7f4efb-85bb-4bd9-a512-1a9a06c7f103",> "sources": [> {> "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",> "type": "TRANSFER"> }> ]> }> ]>}'
1{2 "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg",3 "active_request": {4 "created_at": "2023-04-12T07:29:36+0000",5 "expires_at": "2023-04-19T07:29:36+0000",6 "questions": [7 {8 "answer": {9 "address": {10 "address_line1": "200 Collins Street",11 "address_line2": "200 Collins Street",12 "country_code": "AU",13 "postcode": "3000",14 "state": "VIC",15 "suburb": "Melbourne"16 },17 "attachments": [18 {19 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"20 }21 ],22 "identity_document": {23 "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",24 "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",25 "issuing_country": "AU",26 "number": "123456789",27 "type": "DRIVING_LICENSE"28 },29 "type": "TEXT"30 },31 "attachments": [32 {33 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"34 }35 ],36 "comment": "Please provide more information",37 "description": {38 "en": "Information confirmation",39 "zh": "信息确认"40 },41 "id": "ba7bfb51-77bc-4991-b651-0969ece1d263",42 "key": "PROOF_OF_ADDRESS",43 "liveness": {44 "status": "NOT_STARTED"45 },46 "sources": [47 {48 "id": "318ce9e9-c370-42bd-8192-e78283770c43",49 "person": {50 "first_name": "John",51 "last_name": "Smith"52 },53 "type": "CARDHOLDER"54 }55 ],56 "title": {57 "en": "Information confirmation",58 "zh": "信息确认"59 },60 "uploaded_orders": [61 {62 "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec"63 }64 ]65 }66 ],67 "updated_at": "2023-04-14T07:29:36+0000"68 },69 "answered_requests": [70 {71 "created_at": "2023-04-12T07:29:36+0000",72 "expires_at": "2023-04-19T07:29:36+0000",73 "questions": [74 {75 "answer": {76 "address": {77 "address_line1": "200 Collins Street",78 "address_line2": "200 Collins Street",79 "country_code": "AU",80 "postcode": "3000",81 "state": "VIC",82 "suburb": "Melbourne"83 },84 "attachments": [85 {86 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"87 }88 ],89 "identity_document": {90 "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",91 "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",92 "issuing_country": "AU",93 "number": "123456789",94 "type": "DRIVING_LICENSE"95 },96 "type": "TEXT"97 },98 "attachments": [99 {100 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"101 }102 ],103 "comment": "Please provide more information",104 "description": {105 "en": "Information confirmation",106 "zh": "信息确认"107 },108 "id": "ba7bfb51-77bc-4991-b651-0969ece1d263",109 "key": "PROOF_OF_ADDRESS",110 "liveness": {111 "status": "NOT_STARTED"112 },113 "sources": [114 {115 "id": "318ce9e9-c370-42bd-8192-e78283770c43",116 "person": {117 "first_name": "John",118 "last_name": "Smith"119 },120 "type": "CARDHOLDER"121 }122 ],123 "title": {124 "en": "Information confirmation",125 "zh": "信息确认"126 },127 "uploaded_orders": [128 {129 "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec"130 }131 ]132 }133 ],134 "updated_at": "2023-04-14T07:29:36+0000"135 }136 ],137 "created_at": "2023-04-11T07:29:36+0000",138 "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92",139 "status": "ACTION_REQUIRED",140 "sub_type": "TRANSACTION_MONITORING",141 "type": "KYC",142 "updated_at": "2023-04-12T07:29:36+0000"143}
Close an RFI
POST /api/v1/simulation/rfis/{id}/close
Use this endpoint to close an RFI.
Unique identifier of the RFI
Airwallex account unique identifier
The current RFI request you are required to respond to
Timestamp the RFI request was created
Timestamp the RFI request will expire, and the RFI status will be transited to CLOSED.
List of questions
Response to the question
Response for ADDRESS type
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Response for ATTACHMENT type
File id provided in the response from the File Service API
comment for this response
Response for CONFIRMATION type
Response for IDENTITY_DOCUMENT type
File id of the photo of the back of the document.
File id of the photo of the front of the document.
Country issuing the document. (2-letter ISO 3166-2 country code)
Identity number.
Type of identity document. One of DRIVING_LICENSE,PASSPORT,IDENTITY_CARD,MEDICARE_CARD,SSN,ITIN
Response for TEXT type
The type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
The supporting documents of the question.
File id used in File Service API to get file download link
Additional description for this question
The description of the question.
Content in English
Content in Chinese
Unique identifier for the question.
The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements
Possible values:
PROOF_OF_ADDRESSID_COPY
Information for the LIVENESS type questions
The status of the liveness verification
FAILED, NOT_STARTED, STARTED, SUBMITTED, SUCCEEDED
This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera.
Please note:
- If
LIVENESSis the only question in the RFI, theRespond to an RFIAPI does not need a separate call. It will be auto-resolved after verification. - For RFIs with both
LIVENESSand other questions, please complete liveness verification before responding to the rest.
In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified
Unique identifier for the source
Information for PERSON source
First name of the person
Last name of the person
The type of the source. Type of values and their corresponding API:
-
PERSON: Get account by ID -
BUSINESS: matchaccount_details.business_person_details.person_idwith the source id -
INDIVIDUAL: matchaccount_details.individual_details.person_idwith the source id -
If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.
-
CARDHOLDER: Get cardholder details -
PAYMENT_INTENT: Retrieve a PaymentIntent
For TRANSACTION RFI:
CHARGE: Get a charge by IDTRANSFER: Get a transfer by IDDIRECT_DEBIT: Get direct debit by IDDEPOSIT: Get a deposit by IDPAYMENT: Get payment by ID
The title of the question.
Content in English
Content in Chinese
The uploaded orders which are related to the transaction, only applicable for TRANSACTION RFI.
Unique identifier of the uploaded order.
The latest timestamp the RFI request was updated
The list of RFI requests that have already been responded to
Timestamp the RFI request was created
Timestamp the RFI request will expire, and the RFI status will be transited to CLOSED.
List of questions
Response to the question
Response for ADDRESS type
The first line of a physical address, typically including the street number and name of the building or residence. A P.O. box is not acceptable.
An optional field that can be used to capture additional information about the address, such as the apartment/ suite number, or floor number.
Country code. (2-letter ISO 3166-2 country code)
Postcode or zip code. Only applicable if relevant to selected country.
Name of state. Only applicable if relevant to selected country.
Name of city/suburb.
Response for ATTACHMENT type
File id provided in the response from the File Service API
comment for this response
Response for CONFIRMATION type
Response for IDENTITY_DOCUMENT type
File id of the photo of the back of the document.
File id of the photo of the front of the document.
Country issuing the document. (2-letter ISO 3166-2 country code)
Identity number.
Type of identity document. One of DRIVING_LICENSE,PASSPORT,IDENTITY_CARD,MEDICARE_CARD,SSN,ITIN
Response for TEXT type
The type of response to the question
ADDRESS, ATTACHMENT, CONFIRMATION, IDENTITY_DOCUMENT, LIVENESS, TEXT
The supporting documents of the question.
File id used in File Service API to get file download link
Additional description for this question
The description of the question.
Content in English
Content in Chinese
Unique identifier for the question.
The unique coded value for the RFI scenario the question relates to. This field is used to support automation of RFI responses from the platform for well defined business requirements
Possible values:
PROOF_OF_ADDRESSID_COPY
Information for the LIVENESS type questions
The status of the liveness verification
FAILED, NOT_STARTED, STARTED, SUBMITTED, SUCCEEDED
This URL is used for liveness verification, necessary in certain cases. Ensure recipients open it on their mobile devices, equipped with a valid ID or passport and a working camera.
Please note:
- If
LIVENESSis the only question in the RFI, theRespond to an RFIAPI does not need a separate call. It will be auto-resolved after verification. - For RFIs with both
LIVENESSand other questions, please complete liveness verification before responding to the rest.
In the case where a question is linked to a specific source (such as a cardholder) then the source will be specified
Unique identifier for the source
Information for PERSON source
First name of the person
Last name of the person
The type of the source. Type of values and their corresponding API:
-
PERSON: Get account by ID -
BUSINESS: matchaccount_details.business_person_details.person_idwith the source id -
INDIVIDUAL: matchaccount_details.individual_details.person_idwith the source id -
If there is no matched person on your account, this indicates that Airwallex has introduced a new individual during the review process. Once verification is complete, this person will be added to your account.
-
CARDHOLDER: Get cardholder details -
PAYMENT_INTENT: Retrieve a PaymentIntent
For TRANSACTION RFI:
CHARGE: Get a charge by IDTRANSFER: Get a transfer by IDDIRECT_DEBIT: Get direct debit by IDDEPOSIT: Get a deposit by IDPAYMENT: Get payment by ID
The title of the question.
Content in English
Content in Chinese
The uploaded orders which are related to the transaction, only applicable for TRANSACTION RFI.
Unique identifier of the uploaded order.
The latest timestamp the RFI request was updated
Timestamp the RFI was created
Unique identifier for the RFI
The status of the RFI. Possible values:
ACTION_REQUIRED: Airwallex requires you to respond to the RFI requestANSWERED: You have already responded to the RFI request and your response is being reviewed by AirwallexCLOSED: The review is complete and no further information is required
The sub type of RFI.
For TRANSACTION RFI:
TRANSACTION_MONITORING: Internal transaction monitoringTRANSACTION_SCREENING: Internal transaction screeningBANKING_PARTNER_INQUIRY: External banking partner inquiry
The type of RFI. Currently supports KYC, KYC_ONGOING, CARDHOLDER, TRANSACTION, PAYMENT_ENABLEMENT and MERCHANT_RISK types.
The latest timestamp the RFI was updated
| Error status | Description |
|---|---|
| 400 | invalid_argument |
| 401 | credentials_invalid |
| 404 | not_found |
| 500 | service_unavailable |
$curl --request POST \> --url 'https://api-demo.airwallex.com/api/v1/simulation/rfis/request_for_information_rfi_id/close' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "account_id": "acct_e_2wbiZ3Mx-ynlX-7Qidbg",3 "active_request": {4 "created_at": "2023-04-12T07:29:36+0000",5 "expires_at": "2023-04-19T07:29:36+0000",6 "questions": [7 {8 "answer": {9 "address": {10 "address_line1": "200 Collins Street",11 "address_line2": "200 Collins Street",12 "country_code": "AU",13 "postcode": "3000",14 "state": "VIC",15 "suburb": "Melbourne"16 },17 "attachments": [18 {19 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"20 }21 ],22 "identity_document": {23 "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",24 "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",25 "issuing_country": "AU",26 "number": "123456789",27 "type": "DRIVING_LICENSE"28 },29 "type": "TEXT"30 },31 "attachments": [32 {33 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"34 }35 ],36 "comment": "Please provide more information",37 "description": {38 "en": "Information confirmation",39 "zh": "信息确认"40 },41 "id": "ba7bfb51-77bc-4991-b651-0969ece1d263",42 "key": "PROOF_OF_ADDRESS",43 "liveness": {44 "status": "NOT_STARTED"45 },46 "sources": [47 {48 "id": "318ce9e9-c370-42bd-8192-e78283770c43",49 "person": {50 "first_name": "John",51 "last_name": "Smith"52 },53 "type": "CARDHOLDER"54 }55 ],56 "title": {57 "en": "Information confirmation",58 "zh": "信息确认"59 },60 "uploaded_orders": [61 {62 "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec"63 }64 ]65 }66 ],67 "updated_at": "2023-04-14T07:29:36+0000"68 },69 "answered_requests": [70 {71 "created_at": "2023-04-12T07:29:36+0000",72 "expires_at": "2023-04-19T07:29:36+0000",73 "questions": [74 {75 "answer": {76 "address": {77 "address_line1": "200 Collins Street",78 "address_line2": "200 Collins Street",79 "country_code": "AU",80 "postcode": "3000",81 "state": "VIC",82 "suburb": "Melbourne"83 },84 "attachments": [85 {86 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"87 }88 ],89 "identity_document": {90 "back_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",91 "front_file_id": "N2EwYTllMTgtZmZjOS00ZDllLWI1MDQtMDMyZjAzZTRjZWE0LHwsLHwsQ05fQkxfbmV3LnBuZ18xNjgzNTUyNjg3Nzg3",92 "issuing_country": "AU",93 "number": "123456789",94 "type": "DRIVING_LICENSE"95 },96 "type": "TEXT"97 },98 "attachments": [99 {100 "file_id": "ZTEyOWJjZTItZGI5NS00NzI5LWI1YTQtZmQ2MmZlNDEwNzFlLHwsaG9uZ2tvbmcsfCzpvI7og5xDSS5wZGZfMTY4MzI1Nzg5OTUwOQ"101 }102 ],103 "comment": "Please provide more information",104 "description": {105 "en": "Information confirmation",106 "zh": "信息确认"107 },108 "id": "ba7bfb51-77bc-4991-b651-0969ece1d263",109 "key": "PROOF_OF_ADDRESS",110 "liveness": {111 "status": "NOT_STARTED"112 },113 "sources": [114 {115 "id": "318ce9e9-c370-42bd-8192-e78283770c43",116 "person": {117 "first_name": "John",118 "last_name": "Smith"119 },120 "type": "CARDHOLDER"121 }122 ],123 "title": {124 "en": "Information confirmation",125 "zh": "信息确认"126 },127 "uploaded_orders": [128 {129 "order_id": "e10a8291-fabb-480d-a208-7c8f1c2cc5ec"130 }131 ]132 }133 ],134 "updated_at": "2023-04-14T07:29:36+0000"135 }136 ],137 "created_at": "2023-04-11T07:29:36+0000",138 "id": "de73d13b-cb60-4541-8fa6-4bc50c1cbe92",139 "status": "ACTION_REQUIRED",140 "sub_type": "TRANSACTION_MONITORING",141 "type": "KYC",142 "updated_at": "2023-04-12T07:29:36+0000"143}