API docs by Redocly

GoAML Report Generator API (1.0.0)

Download OpenAPI specification:Download

License: MIT

API for generating various GoAML reports and managing user authentication

Generate Suspicious Transaction Report

Generates a Suspicious Transaction Report (STR)

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
transactionId
string
rentityId
string
rentityBranch
string
submission_code
string
Enum: "E" "M"
report_code
string
Value: "STR"
report_date
string <date-time>
currency_code_local
string
reporting_user_code
string
object (Location)
reason
string
action
string
object (Transaction)
object (ReportIndicators)

Responses

Request samples

Content type
application/json
{
  • "transactionId": "string",
  • "rentityId": "string",
  • "rentityBranch": "string",
  • "submission_code": "E",
  • "report_code": "STR",
  • "report_date": "2019-08-24T14:15:22Z",
  • "currency_code_local": "string",
  • "reporting_user_code": "string",
  • "location": {
    },
  • "reason": "string",
  • "action": "string",
  • "transaction": {
    },
  • "report_indicators": {
    }
}

Generate Funds Transfer Report

Generates a Funds Transfer Report (FTR)

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
transactionId
string
rentityId
string
rentityBranch
string
submission_code
string
Enum: "E" "M"
report_code
string
Value: "FTR"
report_date
string <date-time>
currency_code_local
string
reporting_user_code
string
object (Location)
reason
string
action
string
object (Transaction)
object (ReportIndicators)

Responses

Request samples

Content type
application/json
{
  • "transactionId": "string",
  • "rentityId": "string",
  • "rentityBranch": "string",
  • "submission_code": "E",
  • "report_code": "FTR",
  • "report_date": "2019-08-24T14:15:22Z",
  • "currency_code_local": "string",
  • "reporting_user_code": "string",
  • "location": {
    },
  • "reason": "string",
  • "action": "string",
  • "transaction": {
    },
  • "report_indicators": {
    }
}

Generate Politically Exposed Persons Report

Generates a Politically Exposed Persons (PEP) Report

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
transactionId
string
rentityId
string
rentityBranch
string
submission_code
string
Enum: "E" "M"
report_code
string
Value: "PEP STR"
report_date
string <date-time>
currency_code_local
string
reporting_user_code
string
object (Location)
reason
string
action
string
object (PEPTransaction)
object (ReportIndicators)

Responses

Request samples

Content type
application/json
{
  • "transactionId": "string",
  • "rentityId": "string",
  • "rentityBranch": "string",
  • "submission_code": "E",
  • "report_code": "PEP STR",
  • "report_date": "2019-08-24T14:15:22Z",
  • "currency_code_local": "string",
  • "reporting_user_code": "string",
  • "location": {
    },
  • "reason": "string",
  • "action": "string",
  • "transaction": {
    },
  • "report_indicators": {
    }
}

Generate Suspicious Activity Report

Generates a Suspicious Activity Report (SAR)

Authorizations:
apiKeyAuth
Request Body schema: application/json
required
activityId
string
rentityId
string
rentityBranch
string
submission_code
string
Enum: "E" "M"
report_code
string
Value: "SAR"
report_date
string <date-time>
currency_code_local
string
reporting_user_code
string
object (ReportingPerson)
object (Location)
reason
string
action
string
object (Activity)
object (ReportIndicators)

Responses

Request samples

Content type
application/json
{
  • "activityId": "string",
  • "rentityId": "string",
  • "rentityBranch": "string",
  • "submission_code": "E",
  • "report_code": "SAR",
  • "report_date": "2019-08-24T14:15:22Z",
  • "currency_code_local": "string",
  • "reporting_user_code": "string",
  • "reporting_person": {
    },
  • "location": {
    },
  • "reason": "string",
  • "action": "string",
  • "activity": {
    },
  • "report_indicators": {
    }
}

Get User Reports

Retrieves reports for the authenticated user

Authorizations:
apiKeyAuth
query Parameters
page
integer
Default: 1

Page number for pagination

per_page
integer
Default: 10

Number of items per page

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ],
  • "pagination": {
    }
}

Get Single Report

Retrieves a specific report by ID

Authorizations:
apiKeyAuth
path Parameters
id
required
string

The ID of the report to retrieve

Responses

Get All Banks

Retrieves a list of all banks

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "banks": [
    ]
}

Get All Countries

Retrieves a list of all countries

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "countries": [
    ]
}

Show Create GoAML Report Form

Displays the form to create GoAML reports

query Parameters
token
required
string

Token for accessing the report creation form

Responses

Login with Credentials

Authenticates a user using email and password

Request Body schema: application/json
required
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Login with API Key

Authenticates a user using an API key

Request Body schema: application/json
required
api_key
required
string

Responses

Request samples

Content type
application/json
{
  • "api_key": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}