AML News

The AML News allows you to view news media publications related to customers' AML checks.

Integration Options

Currently only available via the Rest API.

Endpoint

Request type: POST

EnvironmentEndpoint

Sandbox

https://testapi.smileidentity.com/v1/aml/news

Production

https://api.smileidentity.com/v1/aml/news

Request Values

AML News requires the following input parameters which should be contained in a JSON body object submitted to the endpoint

Name

Type

Required

Description

partner_id

string

Yes

A unique number assigned by Smile ID to your account. Can be found in the portal here

signature

string

Yes

The outgoing signature to authenticate the request from you to Smile ID. You can read more about calculating the signature here

timestamp

string

Yes

The timestamp used to calculate the signature in ISO date/time format

user_id

string

Yes

A value generated by you previously used for the AML Check.

job_id

string

Yes

A value generated by you previously used for the AML Check.

ref

string

Yes

The ref related to the found person returned after an AML Check

news_category

string

Yes

The specific category to view. This is returned in the `news_summary`.

page

integer

No

The specific page number you want to visit. If you do not enter any number, you get the first page.

limit

integer

No

The total articles to return per page.

Example JSON Body

{
  "job_id": "3ba0e15e-1a56-4799-a94d-b0e084f50256",
  "partner_id": "023",
  "signature": "...",
  "ref": "...",
  "timestamp": "2021-08-12T17:57:00.614879",
  "user_id": "4cb0f26-2b567-5800-b05e-c0f095g6036",
  "page": 1,
  "limit": 25
}

Return Values

AML News returns related news media of the customer.

Name

Type

Description

Return Values

news

array of objects

A list of the news media

news[].title

string

The news heading

news[].body

string

A summary of the news

news[].publisher

string

The publisher of the news

news[].published_date

string

The date the news was published

news[].publisher_country_code

string

The ISO country code of the publisher when available

news[].url

string

A link to the news publication

meta

object

An object containing page details

meta.currentPage

integer

The current page

meta.limit

integer

The page size provided

meta.totalCount

integer

The total items available

Example JSON Response

{
  "news": [
    {
      "title": "title",
      "body": "body",
      "publisher": "publisher",
      "published_date": "2021-07-01T00:00:00Z",
      "publisher_country_code": "KE",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "currentPage": 1,
    "limit": 25,
    "totalCount": 1
  }
}

Error Codes

Error codes occur when there is a general failure that prevents the system from processing the job.\

Code

Text

Description

2205

You are not authorized to do that.

An invalid signature/timestamp was used to sign the request. You can troubleshoot the error here.

2210

No enrolled user found

You attempted to re-use KYC from a previous Biometric KYC or Document Verification job but the user id was not found in the system. Check the user id resubmit the request

2401

System Error

2403

Invalid JSON

The JSON is wrongly formatted or has an invalid structure

2413

<key> is required

The required key <key> is missing in the request body. Add the key and run the request again.

Result Codes and Result Texts

AML check jobs that are processed successfully can have the following result codes

Last updated