List EDD

Get paginated list of EDD

GET /edd

List EDD

cURL

curl --request GET \
  --url https://api.synctera.com/v2/edd \
  --header 'Authorization: Bearer <token>'

200

{
  "edd_reports": [
    {
      "related_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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"
      ],
      "income": {
        "amount": 1000,
        "currency": "USD"
      },
      "negative_news_findings": 3,
      "occupation": "<string>",
      "recurring_direct_deposit": true,
      "residential_expense": {
        "amount": 1000,
        "currency": "USD"
      },
      "source_of_wealth": []
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer · default: 100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1

Example:

100

page_token · string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

related_resource_id · string<uuid>[]

Unique identifier for the related resource. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

related_resource_type · enum<string>[] · required

Type of related resource. Multiple values can be provided as a comma-separated list.

The type of the resource related to the document

Available options: ACCOUNT, BUSINESS, CUSTOMER, EDD, INVOICE, REVENUE_STATEMENT

Response

200

application/json

List of EDD based on related resource type

edd_reports · (Customer · object | Business · object | Account · object | Transaction · object)[] · required

Array of edd reports.

Additional information submitted about the customer.

Customer

Business

Account

Transaction

Show child attributes

next_page_token · string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"