Consultar status do onboarding (API)
curl --request GET \
--url https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>'import requests
url = "https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status"
headers = {
"client-secret": "<api-key>",
"client-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'client-secret': '<api-key>', 'client-id': '<api-key>'}
};
fetch('https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status', 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://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"client-id: <api-key>",
"client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client-secret", "<api-key>")
req.Header.Add("client-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status")
.header("client-secret", "<api-key>")
.header("client-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client-secret"] = '<api-key>'
request["client-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"external_id": "pedido-123",
"registration_id": "2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f",
"status": "action_required",
"action": "resubmit_documents",
"can_resubmit": true
}Cadastro e onboarding
Consultar status do onboarding
Consulta o status do onboarding de subconta iniciado via API. Retorna status, action e can_resubmit.
GET
/
v2
/
submerchants
/
onboarding
/
{registrationId}
/
status
Consultar status do onboarding (API)
curl --request GET \
--url https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status \
--header 'client-id: <api-key>' \
--header 'client-secret: <api-key>'import requests
url = "https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status"
headers = {
"client-secret": "<api-key>",
"client-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'client-secret': '<api-key>', 'client-id': '<api-key>'}
};
fetch('https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status', 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://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"client-id: <api-key>",
"client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client-secret", "<api-key>")
req.Header.Add("client-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status")
.header("client-secret", "<api-key>")
.header("client-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipay.com.br/v2/submerchants/onboarding/{registrationId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client-secret"] = '<api-key>'
request["client-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"external_id": "pedido-123",
"registration_id": "2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f",
"status": "action_required",
"action": "resubmit_documents",
"can_resubmit": true
}Consulta o status do onboarding iniciado por
POST /v2/submerchants/onboarding/pf ou
POST /v2/submerchants/onboarding/pj. Use o registration_id retornado no
submit. Exige headers client-id + client-secret.Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
external_id | string | null | Valor do x-idempotency-key enviado no onboarding |
registration_id | string (UUID) | ID do registro de onboarding |
status | string | processing, approved, rejected ou action_required |
action | string | none, resubmit_documents ou contact_support |
can_resubmit | boolean | true quando o reenvio de documentos está elegível |
Como usar status, action e can_resubmit
status | action | can_resubmit | O que fazer |
|---|---|---|---|
processing | none | false | Aguarde e consulte de novo |
approved | none | false | Onboarding concluído. Liste a subconta pelo documento para obter o internalId |
action_required | resubmit_documents | true | Reenvie documentos em POST /v2/submerchants/onboarding/{registrationId}/resend-documents |
rejected | contact_support | false | Não reenvie. Contate o suporte |
status da
resposta 202 do submit ou do reenvio não substitui esta consulta.
NOTA: Se can_resubmit for false, o reenvio retorna 409.Headers
Secret da credencial do merchant
ID público da credencial do merchant
Path Parameters
UUID do registro de onboarding retornado no POST /v2/submerchants/onboarding/pf|pj
Response
Status do onboarding
Chave de idempotência enviada no onboarding (x-idempotency-key)
Example:
"pedido-123"
ID do registro de onboarding
Example:
"2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f"
Estado do onboarding para o integrador
Available options:
processing, approved, rejected, action_required Example:
"action_required"
Próxima ação esperada do integrador
Available options:
none, resubmit_documents, contact_support Example:
"resubmit_documents"
Indica se o POST de reenvio de documentos está elegível
Example:
true

