> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a EDD > Create a EDD ## OpenAPI ````yaml openapi.json post /edd openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.208.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > 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. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /edd: summary: EDD post: tags: - EDD summary: Create a EDD description: Create a EDD operationId: createEDD requestBody: content: application/json: schema: $ref: '#/components/schemas/create_edd_request' description: EDD to create required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/create_edd_response' description: Created EDD '400': $ref: '#/components/responses/bad_request' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '409': $ref: '#/components/responses/already_exists' '500': $ref: '#/components/responses/internal_server_error' components: schemas: create_edd_request: discriminator: mapping: ACCOUNT: $ref: '#/components/schemas/edd_account' BUSINESS: $ref: '#/components/schemas/edd_business' CUSTOMER: $ref: '#/components/schemas/edd_customer' TRANSACTION: $ref: '#/components/schemas/edd_transaction' propertyName: related_resource_type oneOf: - $ref: '#/components/schemas/edd_account' - $ref: '#/components/schemas/edd_transaction' - $ref: '#/components/schemas/edd_business' - $ref: '#/components/schemas/edd_customer' create_edd_response: discriminator: mapping: ACCOUNT: $ref: '#/components/schemas/edd_account_response' BUSINESS: $ref: '#/components/schemas/edd_business_response' CUSTOMER: $ref: '#/components/schemas/edd_customer_response' TRANSACTION: $ref: '#/components/schemas/edd_transaction_response' propertyName: related_resource_type oneOf: - $ref: '#/components/schemas/edd_transaction_response' - $ref: '#/components/schemas/edd_account_response' - $ref: '#/components/schemas/edd_customer_response' - $ref: '#/components/schemas/edd_business_response' required: - creation_time - id edd_account: allOf: - $ref: '#/components/schemas/edd_base_report' description: Submit additional information about an account. title: Account edd_business: allOf: - description: The business specific data of this EDD report properties: country: description: ISO-3166-1 Alpha-2 country code example: US pattern: ^[A-Z]{2}$ type: string estimated_revenue: $ref: '#/components/schemas/estimated_revenue' industry_type: $ref: '#/components/schemas/industry_type' negative_news_findings: $ref: '#/components/schemas/negative_news_findings' recurring_wire_usage: description: >- True if the customer is expected to send or receive wire transfers at a regular frequency. example: true type: boolean specific_involvement: $ref: '#/components/schemas/specific_involvement' transaction_volume: description: Array of transaction volumes. items: $ref: '#/components/schemas/transaction_volume' type: array type: object - $ref: '#/components/schemas/edd_base_report' description: Submit additional information about the business. title: Business edd_customer: allOf: - description: The customer specific data of this EDD report properties: citizenship_countries: description: List of countries where the related customer holds citizenship. items: description: ISO-3166-1 Alpha-2 country code example: US pattern: ^[A-Z]{2}$ type: string type: array employment_type: description: The type of employment. enum: - CONTRACTOR - FULL_TIME - INTERN - OTHER - PART_TIME - RETIRED - SELF_EMPLOYED - STUDENT - TEMPORARY - UNEMPLOYED - VOLUNTEER type: string income: $ref: '#/components/schemas/income' negative_news_findings: $ref: '#/components/schemas/negative_news_findings' occupation: description: The occupation of the related resource. type: string occupation_industry: $ref: '#/components/schemas/industry_type' pep_classification: $ref: '#/components/schemas/pep_classification' recurring_direct_deposit: description: >- True if the customer is expected to use direct deposit at a regular frequency. example: true type: boolean residence_type: description: The type of residence. enum: - OTHER - OWN - RENT type: string residential_expense: $ref: '#/components/schemas/residential_expense' source_of_wealth: description: The sources of wealth for the customer. items: $ref: '#/components/schemas/source_of_wealth' type: array type: object - $ref: '#/components/schemas/edd_base_report' description: Submit additional information about the customer. title: Customer edd_transaction: allOf: - description: The transaction specific data of this EDD report properties: source_of_funds: description: The source of funds for the transaction. enum: - INVESTMENT - OTHER - SALARY - SALES type: string transaction_purpose: description: The purpose of the transaction. example: Phone bill type: string type: object - $ref: '#/components/schemas/edd_base_report' description: Submit additional information about a transaction. title: Transaction edd_account_response: allOf: - $ref: '#/components/schemas/edd_base_report' - $ref: '#/components/schemas/edd_base_response' description: Additional information submitted about the account. required: - creation_time - id title: Account edd_business_response: allOf: - $ref: '#/components/schemas/edd_business' - $ref: '#/components/schemas/edd_base_response' description: Additional information submitted about the business. required: - creation_time - id title: Business edd_customer_response: allOf: - $ref: '#/components/schemas/edd_customer' - $ref: '#/components/schemas/edd_base_response' description: Additional information submitted about the customer. required: - creation_time - id title: Customer edd_transaction_response: allOf: - $ref: '#/components/schemas/edd_transaction' - $ref: '#/components/schemas/edd_base_response' description: Additional information submitted about the transaction. required: - creation_time - id title: Transaction error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object edd_base_report: properties: additional_questions: description: Additional questions regarding the related resource items: $ref: '#/components/schemas/question' type: array case_id: description: The ID of the case related to this EDD record maximum: 100000000000 minimum: 0 type: integer reason: description: The reason for this EDD record to be requested enum: - CASE_REQUEST - STANDARD_SUBMISSION type: string related_resource_id: description: related resource UUID format: uuid type: string related_resource_type: $ref: '#/components/schemas/related_resource_type1' tenant: $ref: '#/components/schemas/tenant_id' required: - reason - related_resource_id - related_resource_type title: Edd type: object estimated_revenue: description: The estimated revenue of the business. properties: amount: description: >- The amount earned at the specified frequency. For example, $112.35 USD is represented as 11235 cents). example: 1000 type: integer currency: $ref: '#/components/schemas/currency' frequency: $ref: '#/components/schemas/frequency' type: object industry_type: description: The industry type enum: - ACCOMMODATION_AND_FOOD_SERVICES - >- ADMINISTRATIVE_AND_SUPPORT_AND_WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES - AGRICULTURE_FORESTRY_FISHING_AND_HUNTING - ARTS_ENTERTAINMENT_AND_RECREATION - CONSTRUCTION - EDUCATIONAL_SERVICES - FINANCE_AND_INSURANCE - HEALTH_CARE_AND_SOCIAL_ASSISTANCE - HIGH_RISK_OTHER - INFORMATION - MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES - MANUFACTURING - MINING_QUARRYING_AND_OIL_AND_GAS_EXTRACTION - OTHER_SERVICES - PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES - PUBLIC_ADMINISTRATION - REAL_ESTATE_AND_RENTAL_AND_LEASING - RETAIL_TRADE - TRANSPORTATION_AND_WAREHOUSING - UTILITIES - WHOLESALE_TRADE type: string negative_news_findings: description: The number of negative news findings. example: 3 type: integer specific_involvement: description: Defines if the business is involved in a few high risk industries. properties: arms_defense_or_security: description: >- Defines if the business is in the arms/defense, private security firms, or private military contractors. example: true type: boolean cannabis_industry: description: Defines if the business is in the cannabis industry. example: true type: boolean embassies_or_consulates: description: Defines if the business is an embassy or a consulate. example: true type: boolean illegal_activities_prostitution_or_pirated_goods: description: >- Defines if the business is involved in illegal activities, prostitution, or pirated goods. example: true type: boolean law_firm_or_fiduciary: description: Defines if the business is a law firm or a fiduciary. example: true type: boolean licensed_money_service_business: description: Defines if the business is a licensed money service business. example: true type: boolean lotteries_crypto_currency_or_illegal_internet_gambling: description: >- Defines if the business is a provider of online lottery, mail order lotteries and sweepstakes Non-Fiat Currency (including open loop virtual currency), and Unlawful Internet Gambling. example: true type: boolean ngo_or_nonprofit: description: Defines if the business is a NGO or a nonprofit. example: true type: boolean precious_metals_stones_or_jewellery: description: >- Defines if the business is in the precious metals, stones, jewellery industry, or rough diamond trade. example: true type: boolean shell_banks_or_unlicensed_money_service_business: description: >- Defines if the business is a shell bank or a money service business where licensing is required. example: true type: boolean third_party_processor: description: Defines if the business is a third party processor. example: true type: boolean wellness_gift_cards_wholesaler: description: >- Defines if the business is a salon, massage clinic, spa, gift card retailer, or wholesaler. example: true type: boolean type: object transaction_volume: description: The transaction volume of the business. properties: amount: description: >- The amount of the transactions in ISO 4217 minor currency units. For example, a transaction of $100 USD will be displayed as 10000. example: 1000 type: integer channel: description: The channel of the transaction volume. enum: - ACH - CARDS - CASH - EFT - WIRES type: string channel_coverage: description: The channel coverage of the transaction volume. enum: - DOMESTIC - INTERNATIONAL type: string currency: $ref: '#/components/schemas/currency' frequency: $ref: '#/components/schemas/frequency' on_synctera: description: Whether the transaction volume is on Synctera. example: true type: boolean transaction_count: description: The number of transactions. example: 1000 type: integer type: object income: description: The customer's income. properties: amount: description: >- The amount earned at the specified frequency. For example, $112.35 USD is represented as 11235 cents. example: 1000 maximum: 100000000000 minimum: 0 type: integer currency: $ref: '#/components/schemas/currency' frequency: $ref: '#/components/schemas/frequency' source: description: The source of the income enum: - ALIMONY - EMPLOYMENT - INHERITANCE - INVESTMENT - OTHER - PENSION - REAL_ESTATE - RETIREMENT_INCOME - SCHOLARSHIP - SOCIAL_SECURITY - UNEMPLOYMENT nullable: true type: string type: object pep_classification: description: > The political exposure of the customer. * `NOT_PEP` – The individual is **not** a Politically Exposed Person and has **no known close association** with a PEP.. * `DOMESTIC_PEP` – An individual currently holding (or who has held) a **prominent public function within the same country**, such as a government minister, judge, military officer, or senior executive of a state-owned enterprise. * `FOREIGN_PEP` – An individual currently holding (or who has held) a **prominent public function in a foreign country**, such as a foreign head of state, senior politician, or diplomat. * `INTERNATIONAL_PEP` – An individual currently holding (or who has held) a **prominent function in an international organization**, e.g., a senior officer of the UN, IMF, World Bank, or similar. * `FORMER_PEP` – A person who previously held a PEP position but **no longer exercises public functions**. Still may require enhanced due diligence depending on recency and influence. * `ASSOCIATE_OF_PEP` – An individual with **close ties to a PEP**, such as a known business partner or close friend involved in the same financial or political network. * `FAMILY_MEMBER_OF_PEP` – A **close relative** of a PEP (spouse, partner, child, parent, sibling, in-law, etc.) who may benefit from the PEP’s position. enum: - ASSOCIATE_OF_PEP - DOMESTIC_PEP - FAMILY_MEMBER_OF_PEP - FOREIGN_PEP - FORMER_PEP - INTERNATIONAL_PEP - NOT_PEP type: string residential_expense: description: The residential expense. properties: amount: description: >- The amount paid in residential expenses at the specified frequency. For example, $112.35 USD is represented as 11235 cents). example: 1000 maximum: 100000000000 minimum: 0 type: integer currency: $ref: '#/components/schemas/currency' frequency: $ref: '#/components/schemas/frequency' type: object source_of_wealth: description: The source of wealth for the customer. enum: - INHERITANCE - INVESTMENT - OTHER - PROPERTY_SALE - RETIREMENT - SALARY type: string edd_base_response: properties: creation_time: example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string deletion_time: example: '2010-05-06T12:23:34.321Z' format: date-time nullable: true readOnly: true type: string id: description: EDD record unique identifier example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string required: - creation_time - deletion_time - id type: object question: properties: answer: description: The answer example: Since 2010 type: string question: description: The question example: Since when do you work in this position? type: string section: description: The section of the question example: reason type: string required: - answer - question type: object related_resource_type1: description: related resource type enum: - ACCOUNT - BUSINESS - CUSTOMER - TRANSACTION type: string tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string currency: description: The currency in ISO 4217 format. example: USD pattern: ^[A-Z]{3}$ type: string frequency: description: The frequency of the expense enum: - BI_WEEKLY - DAILY - MONTHLY - ONE_TIME - OTHER - QUARTERLY - SEMI_MONTHLY - WEEKLY - YEARLY nullable: true type: string responses: bad_request: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: BadRequest unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error already_exists: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Resource already exists error internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````