# Quick start guide

This guide will show you how to carry out your first AML check. Note that AML self declaration is only available in Norway.

# Before you start

If you don't have an account already, you need to create a free Signicat account.

This guide assumes that you have access to the production environment.

# 1. Create a client on the Dashboard

Follow the steps in How to create an API client. Select the following scopes:

  • self_declaration_write
  • self_declaration_read

Default settings

You can override some of the default settings of the API, such as the type of flow that the end-user goes through or the style of the generated self declaration document. To do so, open the Dashboard and go to Tools > Setting Sets > AML Self Declaration (the AML Self Declaration entry is under "Products").

# 2. Open Postman or a similar tool

Our developers like to use Postman. It can be downloaded from https://www.getpostman.com.

You can also download the OpenAPI document for our APIs from our API Reference(click the "Download" button at the top of the page).

# 3. Get access token

  1. Create a new empty request.
  2. Open the Authorization tab and set the authorization type to OAuth 2.0.
  3. Click “Get New Access Token”.
  4. Fill in the fields as shown in the image below. Bear in mind that you can only get an access token for scopes that you have access to. The scopes you can access, as well as your Client ID and Client Secret can be found on the PDF you received after onboarding. They are also listed in the developer dashboard.

click-to-zoom

  1. Click “Request Token”, and then “Use Token”.

# 4. Create an assignment

Create an assignment for one or several persons using the Assignment endpoint.

  1. Set the URL of the request to https://amlselfdeclaration-api.azurewebsites.net/Assignment.
  2. Set the HTTP verb to POST.
  3. In the “Body” tab, select the "Raw" option and select JSON in the dropdown list that appears on the right.
  4. Paste the JSON request below into the request body.

Email and phone number

For testing, replace the email address and phone number under "Person" with an address and a phone number that you have access to, so you can view the notifications.

  1. Click “Send”.

Request example

{
  "Flow": "SelfDeclaration",
  "ExternalId": "001",
  "Persons": [
    {
      "FirstName": "Rosa",
      "LastName": "Walters",
      "Address": {
        "Street": "Main street 1",
        "PostalCode": "7052",
        "City": "Trondheim",
        "CountryCode": "NO",
        "Country": "Norway"
      },
      "Mobile": {
        "Prefix": "0047",
        "Number": "phone_number_here"
      },
      "Email": "email_address_here",
      "Notifications": "Email",
      "Language": "EN"
    }
  ],
  "Styling": {
    "ColorTheme": "Default",
    "ThemeMode": "Light",
    "Spinner": "Document"
  },
  "Language": "EN"
}

The response will include the StatusUrl, which you can use to keep track of the status of the assignment. You will also get one URL for each person included in the assignment (under "Persons"): these are the URLs your end-users must use to fill in the self declaration form. End-users will also receive a notification containing their respective URLs by email or SMS, depending on what you specified under Notifications.

Response example

{
    "Id": "9f261eda-6ef6-ea11-af8c-000d3ab010d6",
    "Created": "2020-09-14T09:44:16.4541367Z",
    "StatusUrl": "https://amlselfdeclaration-app-test.azurewebsites.net/status?jwt=eyJ0eXA...",
    "Flow": "SelfDeclaration",
    "ExternalId": "001",
    "AssignmentIdentifier": null,
    "Persons": [
        {
            "Id": "a0261eda-6ef6-ea11-af8c-000d3ab010d6",
            "Created": "2020-09-14T09:44:16.4703079Z",
            "Url": "https://amlselfdeclaration-app-test.azurewebsites.net?jwt=eyJ0eXA...",
            "Identity": null,
            "Files": {},
            "FirstName": "Rosa",
            "LastName": "Walters",
            "BirthDate": null,
            "Address": {
                "Street": "Main street 1",
                "PostalCode": "7052",
                "City": "Trondheim",
                "CountryCode": "NO",
                "Country": "Norway"
            },
            "Mobile": {
                "Prefix": "0047",
                "Number": "00000000"
            },
            "Email": "address@email.com",
            "Notifications": "Email",
            "Tags": [],
            "Language": "EN",
            "QuestionIds": "3,6,7,8"
        }
    ],
    "Tags": [],
    "Styling": {
        "ColorTheme": "Default",
        "ThemeMode": "Light",
        "Spinner": "Document",
        "BackgroundColor": ""
    },
    "CallbackUrl": null,
    "Deadline": "2020-09-16T09:44:16.4541369Z",
    "Language": "EN"
}

# 5. Retrieve information

When the customer has filled in and signed the form, and the AML check has been completed, you can obtain the relevant information using the Fetch assignment endpoint. This endpoint will include a link to an electronically signed document with all the details provided by the end-user. You can also download it from the status page (see the StatusUrl parameter in the response).

  1. Set the URL of the request to https://amlselfdeclaration-api.azurewebsites.net/Assignment/{assignment ID}.
  2. Set the HTTP verb to GET.
  3. Click “Send”.

In the example below, we are retrieving information about the assignment we created in the previous step. Notice that the ID used in the request is the one that was returned in Id in the response above.

Request example

GET https://amlselfdeclaration-api.azurewebsites.net/Assignment/9f261eda-6ef6-ea11-af8c-000d3ab010d6

Response example

{
    "Id": "9f261eda-6ef6-ea11-af8c-000d3ab010d6",
    "Created": "2020-09-14T09:44:16.453",
    "StatusUrl": "https://amlselfdeclaration-app-test.azurewebsites.net/status?jwt=eyJ0eXA...",
    "Flow": "SelfDeclaration",
    "ExternalId": "001",
    "AssignmentIdentifier": null,
    "Persons": [
        {
            "Id": "a0261eda-6ef6-ea11-af8c-000d3ab010d6",
            "Created": "2020-09-14T09:44:16.47",
            "Url": "https://amlselfdeclaration-app-test.azurewebsites.net?jwt=eyJ0eXA...",
            "Identity": null,
            "Files": {},
            "FirstName": "Rosa",
            "LastName": "Walters",
            "BirthDate": null,
            "Address": {
                "Street": "Main street 1",
                "PostalCode": "7052",
                "City": "Trondheim",
                "CountryCode": "NO",
                "Country": "Norway"
            },
            "Mobile": {
                "Prefix": "0047",
                "Number": "00000000"
            },
            "Email": "address@email.com",
            "Notifications": "Email",
            "Tags": [],
            "Language": "EN",
            "QuestionIds": "3,6,7,8"
        }
    ],
    "Tags": [],
    "Styling": {
        "ColorTheme": "Default",
        "ThemeMode": "Light",
        "Spinner": "Document",
        "BackgroundColor": ""
    },
    "CallbackUrl": null,
    "Deadline": "2020-09-16T09:44:16.453",
    "Language": "EN"
}
Last updated: 9/15/2020, 8:45:25 AM