How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Synctera Persons API

A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business.

Synctera Persons API is one of 29 APIs that Synctera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Persons. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 0.20.0.

Requests are made against 2 base URLs: https://api.synctera.com/v0, https://api-sandbox.synctera.com/v0.

5 operations 3 paths 14 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.20.0
Base URL
https://api.synctera.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Synctera Persons API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Persons 5

A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business.

GET
/persons
List persons
listPersons 11 params → 200401403500
POST
/persons
Create a person
createPerson 1 param body → 201400401403409500
GET
/persons/{person_id}
Get person
getPerson 1 param → 200400401403404500
PATCH
/persons/{person_id}
Update person
updatePerson 2 params body → 200400401403404500
POST
/persons/{person_id}/prefill
Prefill person
prefillPerson 2 params body → 200400401403500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are base_person1 (19 properties), address (6 properties), error (4 properties), prefill_request (2 properties). Each schema is shown below with its type and property counts.

is_customer
boolean
True for personal and business customers with a direct relationship with the fintech or bank.
status1
string
Status of the person. One of the following: ACTIVE – is an integrator defined status. Integrators should set a person to active if they believe the person to b…
ban_status
string
(alpha) Ban status of the person. One of the following: ALLOWED – person is not banned BANNED – person is banned
person_list
ssn_source
string
Describes the collection method for the customer's SSN: MANUAL – the full 9 digits of the customer's SSN was collected. PREFILL – the customer's SSN was collec…
paginated_response
object
1 property
error
object
4 properties
metadata
object
Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
base_person1
object
19 properties
prefill_request
object
2 properties
patch_person
object
Person object for patch purpose.
verification_status
string
The result of a KYC/KYB verification. One of the following: UNVERIFIED – verification has not been completed for this customer. PENDING – verification is in pr…
person
object
Person object used in requests.
address
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synctera-persons-api-openapi.yml Raw ↑

Other APIs Synctera publishes across the network.

Synctera Webhooks
Synctera Accounts API
Synctera ACH API
Synctera Applications API
Synctera Businesses API
Synctera Card Transaction Simulations API
Synctera Card Webhook Simulations API
Synctera Cards API
Synctera Customers API
Synctera Digital Wallet Tokens API
Synctera Disclosures API
Synctera Documents (alpha) API
Where this information came from

This is an independent, third-party profile of Synctera Persons API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.