Submit KYB

Submit KYB data for a user.

curl --request POST \
  --url https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "business_name": "<string>",
  "business_phone": "<string>",
  "address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "mcc": "<string>",
  "entity_type": "<string>",
  "formation_date": "<string>",
  "ein": "<string>",
  "document_1": "<string>",
  "document_2": "<string>",
  "dba": "<string>",
  "business_email": "<string>",
  "business_description": "<string>",
  "website": "<string>",
  "document_3": "<string>",
  "document_4": "<string>",
  "document_5": "<string>"
}
'

import requests

url = "https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id}"

payload = {
    "business_name": "<string>",
    "business_phone": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "mcc": "<string>",
    "entity_type": "<string>",
    "formation_date": "<string>",
    "ein": "<string>",
    "document_1": "<string>",
    "document_2": "<string>",
    "dba": "<string>",
    "business_email": "<string>",
    "business_description": "<string>",
    "website": "<string>",
    "document_3": "<string>",
    "document_4": "<string>",
    "document_5": "<string>"
}
headers = {
    "X-Platform-ID": "<x-platform-id>",
    "X-Signature": "<x-signature>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Platform-ID': '<x-platform-id>',
    'X-Signature': '<x-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    business_name: '<string>',
    business_phone: '<string>',
    address: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    country: '<string>',
    mcc: '<string>',
    entity_type: '<string>',
    formation_date: '<string>',
    ein: '<string>',
    document_1: '<string>',
    document_2: '<string>',
    dba: '<string>',
    business_email: '<string>',
    business_description: '<string>',
    website: '<string>',
    document_3: '<string>',
    document_4: '<string>',
    document_5: '<string>'
  })
};

fetch('https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id}', 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.paywint.com/api/platform/kyb/submit-kyb/{user_id}",
  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([
    'business_name' => '<string>',
    'business_phone' => '<string>',
    'address' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'mcc' => '<string>',
    'entity_type' => '<string>',
    'formation_date' => '<string>',
    'ein' => '<string>',
    'document_1' => '<string>',
    'document_2' => '<string>',
    'dba' => '<string>',
    'business_email' => '<string>',
    'business_description' => '<string>',
    'website' => '<string>',
    'document_3' => '<string>',
    'document_4' => '<string>',
    'document_5' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Platform-ID: <x-platform-id>",
    "X-Signature: <x-signature>"
  ],
]);

$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.paywint.com/api/platform/kyb/submit-kyb/{user_id}"

	payload := strings.NewReader("{\n  \"business_name\": \"<string>\",\n  \"business_phone\": \"<string>\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"mcc\": \"<string>\",\n  \"entity_type\": \"<string>\",\n  \"formation_date\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"document_1\": \"<string>\",\n  \"document_2\": \"<string>\",\n  \"dba\": \"<string>\",\n  \"business_email\": \"<string>\",\n  \"business_description\": \"<string>\",\n  \"website\": \"<string>\",\n  \"document_3\": \"<string>\",\n  \"document_4\": \"<string>\",\n  \"document_5\": \"<string>\"\n}")

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

	req.Header.Add("X-Platform-ID", "<x-platform-id>")
	req.Header.Add("X-Signature", "<x-signature>")
	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.paywint.com/api/platform/kyb/submit-kyb/{user_id}")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_name\": \"<string>\",\n  \"business_phone\": \"<string>\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"mcc\": \"<string>\",\n  \"entity_type\": \"<string>\",\n  \"formation_date\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"document_1\": \"<string>\",\n  \"document_2\": \"<string>\",\n  \"dba\": \"<string>\",\n  \"business_email\": \"<string>\",\n  \"business_description\": \"<string>\",\n  \"website\": \"<string>\",\n  \"document_3\": \"<string>\",\n  \"document_4\": \"<string>\",\n  \"document_5\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id}")

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

request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business_name\": \"<string>\",\n  \"business_phone\": \"<string>\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"mcc\": \"<string>\",\n  \"entity_type\": \"<string>\",\n  \"formation_date\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"document_1\": \"<string>\",\n  \"document_2\": \"<string>\",\n  \"dba\": \"<string>\",\n  \"business_email\": \"<string>\",\n  \"business_description\": \"<string>\",\n  \"website\": \"<string>\",\n  \"document_3\": \"<string>\",\n  \"document_4\": \"<string>\",\n  \"document_5\": \"<string>\"\n}"

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

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_name": "<string>",
    "dba": "<string>",
    "business_phone": "<string>",
    "business_email": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "business_description": "<string>",
    "business_id_type": "<string>",
    "website": "<string>",
    "mcc": "<string>",
    "formation_date": "<string>",
    "entity_type": "<string>",
    "status": "<string>",
    "document_1": "<string>",
    "document_2": "<string>",
    "document_3": "<string>",
    "document_4": "<string>",
    "document_5": "<string>"
  },
  "queryGeneratedTime": 1718006400
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

platform

kyb

submit-kyb

{user_id}

Submit KYB data for a user.

curl --request POST \
  --url https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "business_name": "<string>",
  "business_phone": "<string>",
  "address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "mcc": "<string>",
  "entity_type": "<string>",
  "formation_date": "<string>",
  "ein": "<string>",
  "document_1": "<string>",
  "document_2": "<string>",
  "dba": "<string>",
  "business_email": "<string>",
  "business_description": "<string>",
  "website": "<string>",
  "document_3": "<string>",
  "document_4": "<string>",
  "document_5": "<string>"
}
'

import requests

url = "https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id}"

payload = {
    "business_name": "<string>",
    "business_phone": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "mcc": "<string>",
    "entity_type": "<string>",
    "formation_date": "<string>",
    "ein": "<string>",
    "document_1": "<string>",
    "document_2": "<string>",
    "dba": "<string>",
    "business_email": "<string>",
    "business_description": "<string>",
    "website": "<string>",
    "document_3": "<string>",
    "document_4": "<string>",
    "document_5": "<string>"
}
headers = {
    "X-Platform-ID": "<x-platform-id>",
    "X-Signature": "<x-signature>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Platform-ID': '<x-platform-id>',
    'X-Signature': '<x-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    business_name: '<string>',
    business_phone: '<string>',
    address: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    country: '<string>',
    mcc: '<string>',
    entity_type: '<string>',
    formation_date: '<string>',
    ein: '<string>',
    document_1: '<string>',
    document_2: '<string>',
    dba: '<string>',
    business_email: '<string>',
    business_description: '<string>',
    website: '<string>',
    document_3: '<string>',
    document_4: '<string>',
    document_5: '<string>'
  })
};

fetch('https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id}', 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.paywint.com/api/platform/kyb/submit-kyb/{user_id}",
  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([
    'business_name' => '<string>',
    'business_phone' => '<string>',
    'address' => '<string>',
    'city' => '<string>',
    'state' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'mcc' => '<string>',
    'entity_type' => '<string>',
    'formation_date' => '<string>',
    'ein' => '<string>',
    'document_1' => '<string>',
    'document_2' => '<string>',
    'dba' => '<string>',
    'business_email' => '<string>',
    'business_description' => '<string>',
    'website' => '<string>',
    'document_3' => '<string>',
    'document_4' => '<string>',
    'document_5' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Platform-ID: <x-platform-id>",
    "X-Signature: <x-signature>"
  ],
]);

$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.paywint.com/api/platform/kyb/submit-kyb/{user_id}"

	payload := strings.NewReader("{\n  \"business_name\": \"<string>\",\n  \"business_phone\": \"<string>\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"mcc\": \"<string>\",\n  \"entity_type\": \"<string>\",\n  \"formation_date\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"document_1\": \"<string>\",\n  \"document_2\": \"<string>\",\n  \"dba\": \"<string>\",\n  \"business_email\": \"<string>\",\n  \"business_description\": \"<string>\",\n  \"website\": \"<string>\",\n  \"document_3\": \"<string>\",\n  \"document_4\": \"<string>\",\n  \"document_5\": \"<string>\"\n}")

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

	req.Header.Add("X-Platform-ID", "<x-platform-id>")
	req.Header.Add("X-Signature", "<x-signature>")
	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.paywint.com/api/platform/kyb/submit-kyb/{user_id}")
  .header("X-Platform-ID", "<x-platform-id>")
  .header("X-Signature", "<x-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_name\": \"<string>\",\n  \"business_phone\": \"<string>\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"mcc\": \"<string>\",\n  \"entity_type\": \"<string>\",\n  \"formation_date\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"document_1\": \"<string>\",\n  \"document_2\": \"<string>\",\n  \"dba\": \"<string>\",\n  \"business_email\": \"<string>\",\n  \"business_description\": \"<string>\",\n  \"website\": \"<string>\",\n  \"document_3\": \"<string>\",\n  \"document_4\": \"<string>\",\n  \"document_5\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/kyb/submit-kyb/{user_id}")

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

request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business_name\": \"<string>\",\n  \"business_phone\": \"<string>\",\n  \"address\": \"<string>\",\n  \"city\": \"<string>\",\n  \"state\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"mcc\": \"<string>\",\n  \"entity_type\": \"<string>\",\n  \"formation_date\": \"<string>\",\n  \"ein\": \"<string>\",\n  \"document_1\": \"<string>\",\n  \"document_2\": \"<string>\",\n  \"dba\": \"<string>\",\n  \"business_email\": \"<string>\",\n  \"business_description\": \"<string>\",\n  \"website\": \"<string>\",\n  \"document_3\": \"<string>\",\n  \"document_4\": \"<string>\",\n  \"document_5\": \"<string>\"\n}"

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

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "business_name": "<string>",
    "dba": "<string>",
    "business_phone": "<string>",
    "business_email": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "business_description": "<string>",
    "business_id_type": "<string>",
    "website": "<string>",
    "mcc": "<string>",
    "formation_date": "<string>",
    "entity_type": "<string>",
    "status": "<string>",
    "document_1": "<string>",
    "document_2": "<string>",
    "document_3": "<string>",
    "document_4": "<string>",
    "document_5": "<string>"
  },
  "queryGeneratedTime": 1718006400
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

X-Platform-ID

string<uuid>

required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature

string

required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

user_id

string<uuid>

required

Unique identifier (UUID) of the user for whom KYB is being submitted.

Body

application/json

business_name

string

required

The legally registered name of the business.

Maximum string length: 100

business_phone

string

required

Primary phone number used for business contact.

Maximum string length: 15

address

string

required

Street address of the business headquarters or main location.

Maximum string length: 300

city

string

required

City where the business is physically located.

Maximum string length: 50

state

string

required

State, province, or region associated with the business address.

Maximum string length: 50

zip

string

required

Postal or ZIP code for the business location.

Maximum string length: 10

country

string

required

Country where the business is registered. Use ISO-3166 alpha-2 format (e.g., US, CA).

Maximum string length: 50

mcc

string

required

Four-digit Merchant Category Code reflecting the primary line of business.View Merchant Category Code (MCC) List

Maximum string length: 20

entity_type

string

required

Legal structure of the business (e.g., 'ent1', 'ent2'). View Entity Type Code List.

Maximum string length: 50

formation_date

string

required

Date the business entity was officially formed (format: MM-DD-YYYY).

Maximum string length: 20

ein

string

required

Employer Identification Number (EIN) or applicable tax identification number.

Maximum string length: 50

document_1

string

required

First supporting document for KYB verification (e.g., business license or proof of address). Must be a valid, publicly accessible HTTPS URL.

document_2

string

required

Second supporting document. Must be a valid, publicly accessible HTTPS URL.

dba

string | null

"Doing Business As" name if it differs from the legal name

Maximum string length: 100

business_email

string | null

Primary email address used for business communication.

Maximum string length: 150

business_description

string | null

Brief description of the business, including products or services offered.

Maximum string length: 500

website

string | null

Public-facing business website. Must be a valid URL.

Maximum string length: 100

document_3

string | null

Third supporting document. Optional. Must be a valid, publicly accessible HTTPS URL.

document_4

string | null

Fourth supporting document. Optional. Must be a valid, publicly accessible HTTPS URL.

document_5

string | null

Fourth supporting document. Optional. Must be a valid, publicly accessible HTTPS URL.

Response

Successful Response

success

boolean

default:true

Indicates whether the request was processed successfully.

Example:

true

message

string

default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

data

PlatformKybRead · object | null

The main response payload, if applicable

Show child attributes

queryGeneratedTime

number | null

default:1783679844.273462

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400

Users

KYC & KYB

Wallet

Payments

Accept Payments

Cross Border Payments

Bank Accounts

Paywint Bank Accounts

Cards

Check

Payee Management

Payee Bank Accounts

Payee Cards

Payee Addresses

Headers

Path Parameters

Body

Response