Get Supplement Material Status

Endpoint: GET /v2/gc/virtual-accounts/{virtualAccountRequestId}/supplement-material

Description: Retrieve the review status of supplementary KYC material submitted for a virtual account application.

Request

Request Body Field Descriptions (JSON)

Field Name	Type	Required	Description
N/A	N/A	N/A	GET request does not require a JSON body.

Request sample

// No request body required for this GET endpoint.

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code.
state	number	State of the response.
data	object	Supplement material review details.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier.

data object fields:

Field Name	Type	Description
virtualAccountRequestId	string	NeoX identifier for the virtual account application.
supplementMaterialInfo	object	The supplementary material details as originally submitted via the Supplement Virtual Account Material API.
submitTime	date string	Timestamp when the supplementary material was submitted (ISO 8601).
reviewStatus	string	Current review status. Enum: PENDING (awaiting review), APPROVED (accepted), REJECTED (not accepted).
reviewMessage	string	Reviewer comment or reason for rejection. Empty when reviewStatus is PENDING or APPROVED.

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "virtualAccountRequestId": "VA-20240301-00012345",
    "supplementMaterialInfo": {
      "englishName": "Acme Trading Limited",
      "regAddressEng": "Suite 1201, Tower B, 88 Queensway, Admiralty, Hong Kong",
      "bizAddressEng": "Suite 1201, Tower B, 88 Queensway, Admiralty, Hong Kong",
      "enterpriseSubjectType": "COMPANY",
      "independentWebsiteUrl": "https://www.acme-trading.com"
    },
    "submitTime": "2024-03-01T09:15:00Z",
    "reviewStatus": "APPROVED",
    "reviewMessage": ""
  },
  "message": "Successful",
  "neoResponseId": "a2b3c4d5-6789-4e01-f234-567890123456"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/virtual-accounts/{virtualAccountRequestId}/supplement-material" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en"

Notes

• Requires Bearer token in the Authorization header.

• The Accept-Language header can be used to specify the response language (Support: "vi", "en").

• No request body required.

• Replace {virtualAccountRequestId} with the actual virtual account request ID returned by the Create Virtual Account API.

• Use this endpoint to poll the material review result when the VIRTUAL_ACCOUNT webhook has not yet been received.

• If reviewStatus is REJECTED, inspect reviewMessage for the reason, correct the material, and resubmit using the Supplement Virtual Account Material API.