POST
/
adverse_actions
Create an adverse action notice
curl --request POST \
  --url https://api.synctera.com/v1/adverse_actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": {},
  "notification_time": "2010-05-06T12:23:34.321Z",
  "purpose": "ACCOUNT_CLOSURE",
  "reasons": [
    "Too many inquiries or insufficient credit history"
  ],
  "related_resource_id": "42ab5301-92b5-4f8a-bbc4-058119d3f7dc",
  "related_resource_type": "ACCOUNT"
}'
{
  "metadata": {},
  "notification_time": "2010-05-06T12:23:34.321Z",
  "purpose": "ACCOUNT_CLOSURE",
  "reasons": [
    "Too many inquiries or insufficient credit history"
  ],
  "related_resource_id": "42ab5301-92b5-4f8a-bbc4-058119d3f7dc",
  "related_resource_type": "ACCOUNT",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "9980ff38-1876-4fc7-8bc9-bf0490e2f746",
  "last_updated_time": "2010-05-06T12:23:34.321Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

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

Body

application/json

Adverse action notice to be created.

​
notification_time
string<date-time>
required

The date and time the adverse action notice was sent.

Example:

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

​
purpose
enum<string>
required

Purpose or cause of this adverse action notice.

Available options:
ACCOUNT_CLOSURE,
ACCOUNT_OPENING,
APR_INCREASE,
LINE_DECREASE,
OTHER
​
reasons
string[]
required

Reasons (up to 5) provided to customers when adverse action is taken.

Reason provided to customers when adverse action is taken.

​
related_resource_id
string<uuid>
required

Unique identifier for the related resource.

Example:

"42ab5301-92b5-4f8a-bbc4-058119d3f7dc"

​
related_resource_type
enum<string>
required

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

Available options:
ACCOUNT,
BUSINESS,
CUSTOMER
​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

Response

Created adverse action notice.

​
notification_time
string<date-time>
required

The date and time the adverse action notice was sent.

Example:

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

​
purpose
enum<string>
required

Purpose or cause of this adverse action notice.

Available options:
ACCOUNT_CLOSURE,
ACCOUNT_OPENING,
APR_INCREASE,
LINE_DECREASE,
OTHER
​
reasons
string[]
required

Reasons (up to 5) provided to customers when adverse action is taken.

Reason provided to customers when adverse action is taken.

​
related_resource_id
string<uuid>
required

Unique identifier for the related resource.

Example:

"42ab5301-92b5-4f8a-bbc4-058119d3f7dc"

​
related_resource_type
enum<string>
required

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

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

The date and time the resource was created.

Example:

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

​
id
string<uuid>
required

Unique identifier for this adverse action notice.

Example:

"9980ff38-1876-4fc7-8bc9-bf0490e2f746"

​
last_updated_time
string<date-time>
required

The date and time the resource was last update.

Example:

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

​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.