Get Beneficial Owner Signature Status

Get where every beneficial owner stands on their cédula

curl --request GET \
  --url https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures \
  --header 'partner-api-key: <api-key>'

import requests

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

headers = {"partner-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["partner-api-key"] = '<api-key>'

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>"
      }
    ]
  }
}

GET

api

partner

users

{userId}

associated-persons

signatures

Get where every beneficial owner stands on their cédula

curl --request GET \
  --url https://api.sandbox.capa.fi/api/partner/v2/users/{userId}/associated-persons/signatures \
  --header 'partner-api-key: <api-key>'

import requests

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

headers = {"partner-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["partner-api-key"] = '<api-key>'

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>"
      }
    ]
  }
}

Returns where every UBO-role associated person stands on their cédula. Read-only — this is the endpoint to poll, and it’s also the safest fallback for the DOCUMENT_SIGNED webhook.

Important Notes

Every UBO appears, including those never asked for a cédula — those entries carry no status. This avoids a caller believing they’re done because a short list came back, after adding a new owner since their last request.
status is PENDING (awaiting signature) or SIGNED (complete). A missing status means no cédula was ever requested for that owner, or that requesting one previously failed (see error/errorCode).
Every owner reporting SIGNED is what satisfies the cross-ramp signature requirement — poll this endpoint until every UBO shows SIGNED.
signingUrl is only present while status is PENDING; it’s withheld once SIGNED.

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
422	`UNPROCESSABLE_ENTITY`	”User is not a business”
500	`INTERNAL_SERVER_ERROR`	”Internal server error”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Path Parameters

userId

string<uuid>

required

The user's Capa ID

Response

One entry per beneficial owner on record for the business.

success

boolean

Example:

true

data

object

Show child attributes

​Important Notes

​Error Codes

​Common Errors

​User Ownership Errors

​Endpoint-Specific Errors