Query Verification Status

curl --request GET \
  --url https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'

import requests

url = "https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query"

headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-Signature": "<x-gatepay-signature>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-Signature': '<x-gatepay-signature>'
  }
};

fetch('https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'

response = http.request(request)
puts response.read_body

{
  "code": "2",
  "message": "success",
  "data": {
    "merchantNo": "12345678",
    "subAccountId": "53695180",
    "currentAuthStatus": "succeeded",
    "accountType": "KYB",
    "submitTime": 1780036614339,
    "auditTime": 1780036714339
  }
}

GET

pay-cashier

open

certification

verify

query

Query Verification Status

curl --request GET \
  --url https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'

import requests

url = "https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query"

headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-Signature": "<x-gatepay-signature>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-Signature': '<x-gatepay-signature>'
  }
};

fetch('https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/pay-cashier/open/v1/certification/verify/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'

response = http.request(request)
puts response.read_body

{
  "code": "2",
  "message": "success",
  "data": {
    "merchantNo": "12345678",
    "subAccountId": "53695180",
    "currentAuthStatus": "succeeded",
    "accountType": "KYB",
    "submitTime": 1780036614339,
    "auditTime": 1780036714339
  }
}

Overview

This page documents the query verification status endpoint. Parameters, response schema, and examples are rendered from the linked OpenAPI definition above.

Notes

Authentication uses the standard GatePay signed headers.
This dedicated institution endpoint does not use X-GatePay-On-Behalf-Of.
Use subAccountId to query the KYB verification status of the specified sub-account.
For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Use Cases

Poll sub-account verification progress as an institution merchant
Validate that currentAuthStatus is succeeded before initiating downstream business operations

Important Notes

currentAuthStatus values include: un_open, submitted, succeeded, rejected
auditTime is returned only when the status is succeeded or rejected
rejectReason is returned only when the status is rejected; it is omitted when the status is succeeded
After verification completes, GatePay also pushes the result via the Sub-account Verification Result Notification

Headers

X-GatePay-Certificate-ClientId

string

required

The clientId assigned when the merchant registers an application in the Gate merchant console.

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Timestamp

string

required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

Example:

"1672905655498"

X-GatePay-Nonce

string

required

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Example:

"9578"

X-GatePay-Signature

string

required

Request signature. GatePay uses this signature to verify whether the request is valid.

Query Parameters

subAccountId

integer<int64>

required

Institutional sub-account ID

Example:

53695180

Response

200 - application/json

Success

Query verification status response

code

string

Response code

Example:

"2"

message

string

Response message

Example:

"success"

data

object

Verification status query result

Show child attributes

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Query Verification Status

Overview

Notes

Use Cases

Important Notes

Headers

Query Parameters

Response

​Overview

​Notes

​Use Cases

​Important Notes

Headers

Query Parameters

Response

Overview

Notes

Use Cases

Important Notes