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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Synctera

Synctera Customers API

Requests to create and manage customers

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 13 operations across 7 paths, and defines 20 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.

13 operations 7 paths 20 schemas 6 GET1 PATCH4 POST2 PUT

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
Apache 2.0
Resource Areas
1

Authentication & Security 1

Synctera Customers 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 13

Across 7 paths, the API surfaces 13 operations — 6 GET, 1 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 13

Requests to create and manage customers

GET
/customers
List Customers
listCustomers 10 params → 200401403500
POST
/customers
Create a Customer
createCustomer 1 param body → 201400401403409500
GET
/customers/{customer_id}
Get Customer
getCustomer 1 param → 200400401403404500
PATCH
/customers/{customer_id}
Patch Customer
patchCustomer 2 params body → 200400401403404500
PUT
/customers/{customer_id}
Update Customer
updateCustomer 1 param body → 200400401403404500
GET
/customers/{customer_id}/employment
List customer employment records
getAllCustomerEmployment 2 params → 200400404500
POST
/customers/{customer_id}/employment
Create employment record
createCustomerEmployment 2 params body → 201400500
GET
/customers/{customer_id}/employment/{employment_id}
Get customer employment record
getPartyEmployment 2 params → 200400404500
PUT
/customers/{customer_id}/employment/{employment_id}
Update customer employment record
updatePartyEmployment 2 params body → 200400404500
POST
/customers/{customer_id}/prefill
Prefill customer
prefillCustomer 2 params body → 200400401403500
GET
/customers/{customer_id}/risk_ratings
List customer risk ratings
getAllCustomerRiskRatings 2 params → 200400401403404500
POST
/customers/{customer_id}/risk_ratings
Create customer risk rating
createCustomerRiskRating 2 params body → 201400401403404500
GET
/customers/{customer_id}/risk_ratings/{risk_rating_id}
Get customer risk rating
getCustomerRiskRating 2 params → 200400401403404500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are base_person (16 properties), patch_customer (11 properties), employment (9 properties), risk_rating (6 properties). Each schema is shown below with its type and property counts.

customer_in_body
object
ban_status
string
(alpha) Ban status of the person. One of the following: ALLOWED – person is not banned BANNED – person is banned
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
prospect
object
A prospect has a unique identifier. It can be upgrade to a customer with required information
risk_rating_list
employment
object
A period of time in which a customer is (was) employed by a particular employer.
9 properties 1 required
customer
object
Details of a customer
patch_customer
object
Customer object for patch purpose. All fields are optional
11 properties
customer_id
string
base_person
object
16 properties
relationship1
object
2 properties 2 required
prefill_request
object
2 properties
customer_list
customer_kyc_status
string
Customer's KYC status
risk_rating
object
Represents a customer's risk profile
6 properties
address
object
6 properties 2 required
relationship_role
string
CUSTODIAN - Related party is the custodian e.g. the parent, BENEFICIARY - Related party is the beneficiary e.g. the dependent, PARTNER - Related party is the p…
employment_list

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synctera-customers-api-openapi.yml Raw ↑

Other APIs Synctera publishes across the network.

Synctera Webhooks
AE Profile APIs.io
Synctera Accounts API
AE Profile APIs.io
Synctera ACH API
AE Profile APIs.io
Synctera Applications API
AE Profile APIs.io
Synctera Businesses API
AE Profile APIs.io
Synctera Card Transaction Simulations API
AE Profile APIs.io
Synctera Card Webhook Simulations API
AE Profile APIs.io
Synctera Cards API
AE Profile APIs.io
Synctera Digital Wallet Tokens API
AE Profile APIs.io
Synctera Disclosures API
AE Profile APIs.io
Synctera Documents (alpha) API
AE Profile APIs.io
Synctera External Accounts API
AE Profile APIs.io
#Customers
← Back to S APIs
API Details
ID
synctera:synctera-customers-api
Base URL
https://api.synctera.com
Docs
https://docs.synctera.com/api-reference
Provider
Synctera
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=synctera-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/synctera-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Synctera Customers 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.