Submete KYC

Envia documentos de KYC (multipart/form-data)

curl --request POST \
  --url https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-key>' \
  --form selfie=@example-file \
  --form documentFront=@example-file \
  --form documentBack=@example-file \
  --form documentPhoto=@example-file \
  --form documentDigital=@example-file \
  --form cnpjCard=@example-file \
  --form socialContract=@example-file

import requests

url = "https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit"

files = {
    "selfie": ("example-file", open("example-file", "rb")),
    "documentFront": ("example-file", open("example-file", "rb")),
    "documentBack": ("example-file", open("example-file", "rb")),
    "documentPhoto": ("example-file", open("example-file", "rb")),
    "documentDigital": ("example-file", open("example-file", "rb")),
    "cnpjCard": ("example-file", open("example-file", "rb")),
    "socialContract": ("example-file", open("example-file", "rb"))
}
headers = {
    "x-api-key": "<api-key>",
    "x-api-secret": "<api-key>"
}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('selfie', '<string>');
form.append('documentFront', '<string>');
form.append('documentBack', '<string>');
form.append('documentPhoto', '<string>');
form.append('documentDigital', '<string>');
form.append('cnpjCard', '<string>');
form.append('socialContract', '<string>');

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'x-api-secret': '<api-key>'}
};

options.body = form;

fetch('https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit', 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.astronpay.co/api/v1/receivers/{id}/kyc/submit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>",
    "x-api-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-api-secret", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit")
  .header("x-api-key", "<api-key>")
  .header("x-api-secret", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "PF",
  "name": "João Silva",
  "document": "12345678901",
  "documentType": "CPF",
  "status": "PENDING",
  "kycStatus": "PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "phone": "+5511999999999",
  "limits": {
    "dailyLimitBrl": 50000,
    "dailyTransactionLimit": 20,
    "nightTransactionsEnabled": false
  },
  "walletAddress": "4k5d...Solana",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "VALIDATION_ERROR",
  "message": "Campo 'amountBrl' é obrigatório",
  "details": {},
  "requestId": "req_abc123"
}

{
  "error": "VALIDATION_ERROR",
  "message": "Campo 'amountBrl' é obrigatório",
  "details": {},
  "requestId": "req_abc123"
}

POST

receivers

{id}

kyc

submit

Envia documentos de KYC (multipart/form-data)

curl --request POST \
  --url https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-key>' \
  --form selfie=@example-file \
  --form documentFront=@example-file \
  --form documentBack=@example-file \
  --form documentPhoto=@example-file \
  --form documentDigital=@example-file \
  --form cnpjCard=@example-file \
  --form socialContract=@example-file

import requests

url = "https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit"

files = {
    "selfie": ("example-file", open("example-file", "rb")),
    "documentFront": ("example-file", open("example-file", "rb")),
    "documentBack": ("example-file", open("example-file", "rb")),
    "documentPhoto": ("example-file", open("example-file", "rb")),
    "documentDigital": ("example-file", open("example-file", "rb")),
    "cnpjCard": ("example-file", open("example-file", "rb")),
    "socialContract": ("example-file", open("example-file", "rb"))
}
headers = {
    "x-api-key": "<api-key>",
    "x-api-secret": "<api-key>"
}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('selfie', '<string>');
form.append('documentFront', '<string>');
form.append('documentBack', '<string>');
form.append('documentPhoto', '<string>');
form.append('documentDigital', '<string>');
form.append('cnpjCard', '<string>');
form.append('socialContract', '<string>');

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'x-api-secret': '<api-key>'}
};

options.body = form;

fetch('https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit', 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.astronpay.co/api/v1/receivers/{id}/kyc/submit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>",
    "x-api-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-api-secret", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit")
  .header("x-api-key", "<api-key>")
  .header("x-api-secret", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronpay.co/api/v1/receivers/{id}/kyc/submit")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentFront\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentBack\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentPhoto\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documentDigital\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cnpjCard\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"socialContract\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "PF",
  "name": "João Silva",
  "document": "12345678901",
  "documentType": "CPF",
  "status": "PENDING",
  "kycStatus": "PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "phone": "+5511999999999",
  "limits": {
    "dailyLimitBrl": 50000,
    "dailyTransactionLimit": 20,
    "nightTransactionsEnabled": false
  },
  "walletAddress": "4k5d...Solana",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "VALIDATION_ERROR",
  "message": "Campo 'amountBrl' é obrigatório",
  "details": {},
  "requestId": "req_abc123"
}

{
  "error": "VALIDATION_ERROR",
  "message": "Campo 'amountBrl' é obrigatório",
  "details": {},
  "requestId": "req_abc123"
}

Authorizations

x-api-key

string

header

required

x-api-secret

string

header

required

Path Parameters

string<uuid>

required

Body

multipart/form-data

documentType

enum<string>

required

Tipo de documento de identidade pessoal do receiver ou sócio.

Available options:

rg,

cnh

selfie

file

Selfie do receiver (obrigatório para PF e PJ).

documentFront

file

Frente do RG (obrigatório quando documentType=rg).

documentBack

file

Verso do RG (obrigatório quando documentType=rg).

documentPhoto

file

Foto da CNH (uma das duas opções quando documentType=cnh).

documentDigital

file

CNH digital (uma das duas opções quando documentType=cnh).

cnpjCard

file

Cartão CNPJ (obrigatório para receivers PJ).

Contrato social (obrigatório para receivers PJ).

Response

Documentos recebidos; KYC em análise

string<uuid>

required

merchantId

string<uuid>

required

type

enum<string>

required

Available options:

PF,

PJ

name

string

required

Example:

"João Silva"

document

string

required

Example:

"12345678901"

documentType

enum<string>

required

Available options:

CPF,

CNPJ

status

enum<string>

required

Available options:

PENDING,

ACTIVE,

SUSPENDED,

BLOCKED

kycStatus

enum<string>

required

Available options:

PENDING,

SUBMITTED,

UNDER_REVIEW,

APPROVED,

REJECTED

createdAt

string<date-time>

required

string<email> | null

phone

string | null

Example:

"+5511999999999"

limits

object

Show child attributes

walletAddress

string | null

Example:

"4k5d...Solana"

updatedAt

string<date-time>

Introdução

Conceitos

Guias

Webhooks recebidos

Fee Tiers

Receivers

Quote

Payin

Payout

Orders

Merchant Wallet

Ledger

Webhook Config

Authorizations

Path Parameters

Body

Response