Skip to main content
POST
/
edd
Create a EDD
curl --request POST \
  --url https://api.synctera.com/v2/edd \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "CASE_REQUEST",
  "related_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "related_resource_type": "CUSTOMER",
  "additional_questions": [
    {
      "answer": "Since 2010",
      "question": "Since when do you work in this position?",
      "section": "reason"
    }
  ],
  "case_id": 50000000000,
  "tenant": "abcdef_ghijkl",
  "citizenship_countries": [
    "US"
  ],
  "employment_type": "FULL_TIME",
  "income": {
    "amount": 1000,
    "currency": "USD",
    "frequency": "ONE_TIME",
    "source": "EMPLOYMENT"
  },
  "negative_news_findings": 3,
  "occupation": "<string>",
  "occupation_industry": "AGRICULTURE_FORESTRY_FISHING_AND_HUNTING",
  "pep_classification": "NOT_PEP",
  "recurring_direct_deposit": true,
  "residence_type": "OWN",
  "residential_expense": {
    "amount": 1000,
    "currency": "USD",
    "frequency": "ONE_TIME"
  },
  "source_of_wealth": [
    "SALARY"
  ]
}
'
{
  "reason": "CASE_REQUEST",
  "related_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "related_resource_type": "CUSTOMER",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "deletion_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "additional_questions": [
    {
      "answer": "Since 2010",
      "question": "Since when do you work in this position?",
      "section": "reason"
    }
  ],
  "case_id": 50000000000,
  "tenant": "abcdef_ghijkl",
  "citizenship_countries": [
    "US"
  ],
  "employment_type": "FULL_TIME",
  "income": {
    "amount": 1000,
    "currency": "USD",
    "frequency": "ONE_TIME",
    "source": "EMPLOYMENT"
  },
  "negative_news_findings": 3,
  "occupation": "<string>",
  "occupation_industry": "AGRICULTURE_FORESTRY_FISHING_AND_HUNTING",
  "pep_classification": "NOT_PEP",
  "recurring_direct_deposit": true,
  "residence_type": "OWN",
  "residential_expense": {
    "amount": 1000,
    "currency": "USD",
    "frequency": "ONE_TIME"
  },
  "source_of_wealth": [
    "SALARY"
  ]
}

Body

application/json

EDD to create

The customer specific data of this EDD report

​
reason
enum<string>
required

The reason for this EDD record to be requested

Available options:
CASE_REQUEST,
STANDARD_SUBMISSION
​
related_resource_id
string<uuid>
required

related resource UUID

​
related_resource_type
enum<string>
required

The type of the resource related to this adverse action notice.

Available options:
CUSTOMER,
BUSINESS,
ACCOUNT
​
additional_questions
object[]

Additional questions regarding the related resource

​
case_id
integer

The ID of the case related to this EDD record

Required range: 0 <= x <= 100000000000
​
tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
citizenship_countries
string[]

List of countries where the related customer holds citizenship.

ISO-3166-1 Alpha-2 country code

​
employment_type
enum<string>

The type of employment.

Available options:
FULL_TIME,
PART_TIME,
CONTRACTOR,
TEMPORARY,
INTERN,
VOLUNTEER,
RETIRED,
STUDENT,
SELF_EMPLOYED,
UNEMPLOYED,
OTHER
​
income
object

The customer's income.

​
negative_news_findings
integer

The number of negative news findings.

Example:

3

​
occupation
string

The occupation of the related resource.

​
occupation_industry
enum<string>

The industry type

Available options:
AGRICULTURE_FORESTRY_FISHING_AND_HUNTING,
MINING_QUARRYING_AND_OIL_AND_GAS_EXTRACTION,
UTILITIES,
CONSTRUCTION,
MANUFACTURING,
WHOLESALE_TRADE,
RETAIL_TRADE,
TRANSPORTATION_AND_WAREHOUSING,
INFORMATION,
FINANCE_AND_INSURANCE,
REAL_ESTATE_AND_RENTAL_AND_LEASING,
PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES,
MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES,
ADMINISTRATIVE_AND_SUPPORT_AND_WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES,
EDUCATIONAL_SERVICES,
HEALTH_CARE_AND_SOCIAL_ASSISTANCE,
ARTS_ENTERTAINMENT_AND_RECREATION,
ACCOMMODATION_AND_FOOD_SERVICES,
OTHER_SERVICES,
PUBLIC_ADMINISTRATION,
HIGH_RISK_OTHER
​
pep_classification
enum<string>

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.
Available options:
NOT_PEP,
DOMESTIC_PEP,
FOREIGN_PEP,
INTERNATIONAL_PEP,
FORMER_PEP,
ASSOCIATE_OF_PEP,
FAMILY_MEMBER_OF_PEP
​
recurring_direct_deposit
boolean

True if the customer is expected to use direct deposit at a regular frequency.

Example:

true

​
residence_type
enum<string>

The type of residence.

Available options:
OWN,
RENT,
OTHER
​
residential_expense
object

The residential expense.

​
source_of_wealth
enum<string>[]

The sources of wealth for the customer.

The source of wealth for the customer.

Available options:
SALARY,
PROPERTY_SALE,
INVESTMENT,
RETIREMENT,
INHERITANCE,
OTHER

Response

Created EDD

The customer specific data of this EDD report

​
reason
enum<string>
required

The reason for this EDD record to be requested

Available options:
CASE_REQUEST,
STANDARD_SUBMISSION
​
related_resource_id
string<uuid>
required

related resource UUID

​
related_resource_type
enum<string>
required

The type of the resource related to this adverse action notice.

Available options:
CUSTOMER,
BUSINESS,
ACCOUNT
​
creation_time
string<date-time>
required
Example:

"2010-05-06T12:23:34.321Z"

​
deletion_time
string<date-time> | null
required
Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

EDD record unique identifier

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
additional_questions
object[]

Additional questions regarding the related resource

​
case_id
integer

The ID of the case related to this EDD record

Required range: 0 <= x <= 100000000000
​
tenant
string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
citizenship_countries
string[]

List of countries where the related customer holds citizenship.

ISO-3166-1 Alpha-2 country code

​
employment_type
enum<string>

The type of employment.

Available options:
FULL_TIME,
PART_TIME,
CONTRACTOR,
TEMPORARY,
INTERN,
VOLUNTEER,
RETIRED,
STUDENT,
SELF_EMPLOYED,
UNEMPLOYED,
OTHER
​
income
object

The customer's income.

​
negative_news_findings
integer

The number of negative news findings.

Example:

3

​
occupation
string

The occupation of the related resource.

​
occupation_industry
enum<string>

The industry type

Available options:
AGRICULTURE_FORESTRY_FISHING_AND_HUNTING,
MINING_QUARRYING_AND_OIL_AND_GAS_EXTRACTION,
UTILITIES,
CONSTRUCTION,
MANUFACTURING,
WHOLESALE_TRADE,
RETAIL_TRADE,
TRANSPORTATION_AND_WAREHOUSING,
INFORMATION,
FINANCE_AND_INSURANCE,
REAL_ESTATE_AND_RENTAL_AND_LEASING,
PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES,
MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES,
ADMINISTRATIVE_AND_SUPPORT_AND_WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES,
EDUCATIONAL_SERVICES,
HEALTH_CARE_AND_SOCIAL_ASSISTANCE,
ARTS_ENTERTAINMENT_AND_RECREATION,
ACCOMMODATION_AND_FOOD_SERVICES,
OTHER_SERVICES,
PUBLIC_ADMINISTRATION,
HIGH_RISK_OTHER
​
pep_classification
enum<string>

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.
Available options:
NOT_PEP,
DOMESTIC_PEP,
FOREIGN_PEP,
INTERNATIONAL_PEP,
FORMER_PEP,
ASSOCIATE_OF_PEP,
FAMILY_MEMBER_OF_PEP
​
recurring_direct_deposit
boolean

True if the customer is expected to use direct deposit at a regular frequency.

Example:

true

​
residence_type
enum<string>

The type of residence.

Available options:
OWN,
RENT,
OTHER
​
residential_expense
object

The residential expense.

​
source_of_wealth
enum<string>[]

The sources of wealth for the customer.

The source of wealth for the customer.

Available options:
SALARY,
PROPERTY_SALE,
INVESTMENT,
RETIREMENT,
INHERITANCE,
OTHER