3 - Document Consultation

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "busca": {
    "authHeaderName": "<string>",
    "authHeaderValue": "<string>",
    "method": "<string>",
    "contentType": "<string>",
    "url": "<string>",
    "body": "<string>"
  }
}
'

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento"

payload = { "busca": {
        "authHeaderName": "<string>",
        "authHeaderValue": "<string>",
        "method": "<string>",
        "contentType": "<string>",
        "url": "<string>",
        "body": "<string>"
    } }
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    busca: {
      authHeaderName: '<string>',
      authHeaderValue: '<string>',
      method: '<string>',
      contentType: '<string>',
      url: '<string>',
      body: JSON.stringify('<string>')
    }
  })
};

fetch('https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento', 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.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'busca' => [
        'authHeaderName' => '<string>',
        'authHeaderValue' => '<string>',
        'method' => '<string>',
        'contentType' => '<string>',
        'url' => '<string>',
        'body' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>"
  ],
]);

$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.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento"

	payload := strings.NewReader("{\n  \"busca\": {\n    \"authHeaderName\": \"<string>\",\n    \"authHeaderValue\": \"<string>\",\n    \"method\": \"<string>\",\n    \"contentType\": \"<string>\",\n    \"url\": \"<string>\",\n    \"body\": \"<string>\"\n  }\n}")

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

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	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.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"busca\": {\n    \"authHeaderName\": \"<string>\",\n    \"authHeaderValue\": \"<string>\",\n    \"method\": \"<string>\",\n    \"contentType\": \"<string>\",\n    \"url\": \"<string>\",\n    \"body\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Pessoa/ConsultarDocumento")

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

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"busca\": {\n    \"authHeaderName\": \"<string>\",\n    \"authHeaderValue\": \"<string>\",\n    \"method\": \"<string>\",\n    \"contentType\": \"<string>\",\n    \"url\": \"<string>\",\n    \"body\": \"<string>\"\n  }\n}"

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

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tipoDocumento": 123,
  "nomeArquivo": "<string>",
  "extensao": "<string>",
  "dtValidade": "2023-11-07T05:31:56Z",
  "arquivo": "aSDinaTvuI8gbWludGxpZnk="
}

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ]
}

Through this endpoint, the system transmits a request to the URL defined by the partner and then obtains a response containing the document to be attached to the Person API.

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

busca · object

Show child attributes

Response

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

codigo · string<uuid> | null

tipoDocumento · integer<int32>

nomeArquivo · string | null

extensao · string | null

dtValidade · string<date-time> | null

arquivo · string<byte> | null