Application Shortcut Urls

Added

The ability to query a number of urls into First AML applications has been added to the Public API.

These include the view urls in the First AML Platform for:

  • Cases
  • Individuals
  • Entities

An example query requesting all of the above would look like the following:

query ViewUrls($caseId: String!) {
	caseDetails(caseId: $caseId) {
		... on CaseInformation {
			caseId
			name
			urls {
				view
			}
			individuals {
				individualId
				legalName {
					firstName
					lastName
				}
				urls {
					view
				}
			}
			entities {
				legalName
				urls {
					view
				}
			}
		}
	}
}

These fields return stable urls to the API which will redirect to the First AML Platform when viewed.

We have also added the ability to query the verification url for individuals. This allows you to direct individuals quickly to a process where they can begin to complete the First AML verification process. The ability to query this verification url may not always be valid depending on the state of the case or the individual. If this is the case then an InvalidUrl will be returned.

An example query for the verification url of individuals on a case is:

query VerificationUrls($caseId: String!) {
	caseDetails(caseId: $caseId) {
		... on CaseInformation {
			caseId
			individuals {
				individualId
        preferredName {
	        firstName
          lastName
        }
        urls {
			    verification {
						... on ValidUrl {
							url
						}
						... on InvalidUrl {
							message
						}
					}
				}
			}
		}
	}
}

Getting Started
Authentication
Domain Concepts
API Features
Zapier
Embedded EIV
Help