Request Beneficial Owner Signatures

Request a signature link for each beneficial owner who does not already have one

curl --request POST \
  --url https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <api-key>' \
  --data '
{
  "country": "MX"
}
'

import requests

url = "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures"

payload = { "country": "MX" }
headers = {
    "partner-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'partner-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({country: 'MX'})
};

fetch('https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures', 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.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures",
  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([
    'country' => 'MX'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "partner-api-key: <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.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures"

	payload := strings.NewReader("{\n  \"country\": \"MX\"\n}")

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

	req.Header.Add("partner-api-key", "<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.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures")
  .header("partner-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"MX\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures")

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

request = Net::HTTP::Post.new(url)
request["partner-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country\": \"MX\"\n}"

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

{
  "success": true,
  "data": {
    "count": 123,
    "total": 123,
    "data": [
      {
        "associatedPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "PENDING",
        "signingUrl": "<string>",
        "signedAt": "2023-11-07T05:31:56Z",
        "error": "<string>",
        "errorCode": "<string>"
      }
    ]
  }
}

POST

api

partner

users

{userId}

associated-persons

signatures

Request a signature link for each beneficial owner who does not already have one

curl --request POST \
  --url https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <api-key>' \
  --data '
{
  "country": "MX"
}
'

import requests

url = "https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures"

payload = { "country": "MX" }
headers = {
    "partner-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'partner-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({country: 'MX'})
};

fetch('https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures', 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.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures",
  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([
    'country' => 'MX'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "partner-api-key: <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.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures"

	payload := strings.NewReader("{\n  \"country\": \"MX\"\n}")

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

	req.Header.Add("partner-api-key", "<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.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures")
  .header("partner-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"MX\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures")

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

request = Net::HTTP::Post.new(url)
request["partner-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country\": \"MX\"\n}"

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

{
  "success": true,
  "data": {
    "count": 123,
    "total": 123,
    "data": [
      {
        "associatedPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "PENDING",
        "signingUrl": "<string>",
        "signedAt": "2023-11-07T05:31:56Z",
        "error": "<string>",
        "errorCode": "<string>"
      }
    ]
  }
}

Requests a cédula (beneficial owner declaration) signing link for every UBO-role associated person on record for a business user who doesn’t already have one. See Associated Person Signature for the full flow.

Important Notes

MX only. country must be MX — the cédula’s legal basis (art. 95 Bis LGOAAC) is Mexico-specific.
Idempotent. An owner with an outstanding (PENDING) or completed (SIGNED) cédula is left untouched; their existing state is returned rather than a new link being issued. Calling this repeatedly never produces a second link for the same owner.
Partial failure is per-owner. A failure for one owner (e.g. missing email) doesn’t block the others — each result carries its own status/error.
Capa sends no email. Delivering each signingUrl to its owner is the caller’s responsibility. Treat signingUrl as sensitive — anyone holding it can sign as that owner.
The business must be KYB-verified for MX and have at least one UBO-role associated person on record, and at most 25.
Every UBO must have an email set — otherwise that owner’s entry in the response carries an error/errorCode instead of a signingUrl.
Supports an optional Idempotency-Key header (16–128 printable ASCII characters) to protect against duplicate submissions from client-side retries.

Error Codes

Common Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”API Key is missing”
401	`UNAUTHORIZED`	”Invalid API Key format”
401	`UNAUTHORIZED`	”Invalid API Key”
403	`INVALID_PARTNER_FLOW`	”The partner has an invalid flow.”

User Ownership Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”Partner information is required for this operation”
401	`UNAUTHORIZED`	”User is not associated with the partner”

Endpoint-Specific Errors

HTTP Status	Code	Message
400	`INVALID_USER_INPUT_ERROR`	”Invalid User Input”
403	`USER_NOT_VERIFIED_ERROR`	”Business KYB verification is not verified for this country”
404	`NOT_FOUND_ERROR`	”No business identity found for user”
422	`UNPROCESSABLE_ENTITY`	”Business has no beneficial owners on record”
422	`UNPROCESSABLE_ENTITY`	”Business reports more than 25 beneficial owners”
422	`UNPROCESSABLE_ENTITY`	”The beneficial-owner cédula is only available for MX; is not supported”
500	`INTERNAL_SERVER_ERROR`	”Internal server error”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Headers

Idempotency-Key

string

Optional. 16–128 printable ASCII characters. A repeated request with the same key and body replays the original response instead of processing twice.

Path Parameters

userId

string<uuid>

required

The user's Capa ID

Body

application/json

country

string

required

The regime requiring the cédula — the country the business's KYB was verified under. Only MX is currently supported (the cédula's legal basis, art. 95 Bis LGOAAC, is Mexico-specific).

Example:

"MX"

Response

One result per beneficial owner: newly requested, already outstanding/complete, or failed.

success

boolean

Example:

true

data

object

Show child attributes

​Important Notes

​Error Codes

​Common Errors

​User Ownership Errors

​Endpoint-Specific Errors

Authorizations

Headers

Path Parameters

Body

Response

Important Notes

Error Codes

Common Errors

User Ownership Errors

Endpoint-Specific Errors