Skip to main content
POST
/
v3
/
{customerId}
/
Categorization
/
Upload
Upload Categorization
curl --request POST \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/Categorization/Upload \
  --header 'Content-Type: application/json' \
  --data '
{
  "OriginCountry": "us",
  "Transactions": []
}
'
{
  "HttpStatusCode": 123,
  "LoginId": "<string>",
  "RequestId": "<string>",
  "Transactions": [
    {
      "Description": "<string>",
      "Category": "<string>",
      "SubCategory": "<string>",
      "Debit": 123,
      "Credit": 123,
      "Date": "<string>"
    }
  ]
}
This endpoint will allow your teams to generate Broad Categorization Responses from External Data. This endpoint differs from previous /Upload endpoints. You should use this endpoint if you are looking to return Broad Categorization—Broad Categorization is defined at Flinks as attempting to return both a Category and a SubCategory on every single transaction. This differs from our other /Upload endpoints, as they are more focused on Attributes—where the models are focused on depth over breadth. Currently, we only support this feature within the US Market. In order to use this endpoint, your transactions object must be formatted in the same way as defined under the Transforming External Data section of this documentation.

A note on Authorization

In order to access and use any of the /Upload endpoints, you will need a secret authorization token from Flinks. If you do not already have one, please reach out to your Flinks Representative.

​
Request Fields

NAMEDESCRIPTIONRequired?
OriginCountryTells the API to use a specific country model. Only accepted values are us.Yes
TransactionsContains the previously formatted transactions (defined earlier in the documentation) that you are uploading to Flinks.Yes
UserIdentifierOptional ID used to identify a request. When provided, it replaces the randomly generated GUID value within the Card. Typically used to map requests to your internal user ID and is passed through to the response.No

Note on Optional Parameters

All optional parameters listed in the Optional Parameters section of this documentation can also be used by embedding them within the ‘Options’ object.

Headers

​
Authorization
string
default:Bearer {API Secret}

Contains the Bearer Token (the API secret key that Flinks provides you with).

Path Parameters

​
customerId
string
required

Body

application/json
​
OriginCountry
string
default:us
required

Tells the API to use a specific country model. Only accepted value is: - us = United States

​
Transactions
object[]
required

Contains the previously formatted transactions (defined earlier in this documentation) that you are uploading to Flinks.

​
Options
object

Additional parameters that you want to include.

​
UserIdentifier
string

UserIdentifier is an optional ID used to identify a request. It replaces the randomly generated GUID value within the Card when it is present and is normally used to map to an ID on your side to relate to the user once a response has been received. It is passed through to the response.

Response

Example Response

​
HttpStatusCode
integer
​
LoginId
string
​
RequestId
string
​
Transactions
object[]