Getting Started

Base URLs

Customer Test Environment

https://api.uat.securefinancing.com/v1

The Customer Test Environment URL above provides a fully functional API for testing and development. Please do not use real client data for testing in the environment. When a new major version of the API is going to be released it will be available in the environmnet for some time before it becomes available in production.

Production

https://api.securefinancing.com/v1

For live usage with real client data only. You must be approved for production credentials prior to using this URL. Please use the Customer Test environment for all integration work and testing, prior to migrating to production.

Client Authentication

Authentication for the API uses the OAuth2.0 standard with JWT tokens. To generate a token you will invoke a POST on the https://auth.uat.securefinancing.com/oauth/token endpoint for the Customer Test environment, and https://auth.securefinancing.com/oauth/token for production, without any url parameters. The request body for the endpoint call should contain the MonetaGo-provided client id, client secret and oauth audience values. (Note that this is a OAuth2ClientCredentials oauth flow):

{
    "client_id": "<client-id>",
    "client_secret": "<client-secret>",
    "audience": "<oauth-audience>",
    "grant_type":"client_credentials"
}

A sample response would contain the base64 encoded JWT token and token expiry details.

{
    "access_token": "<base64 encoded JWT Token Value>",
    "expires_in": 43200,
    "token_type": "Bearer"
}

For any subsequent calls you will provide the token value in the Authentication header as a bearer token. For example:

{"Authentication": "Bearer <base64 encoded JWT Token Value>"}

The Basic Workflow

The API is split into 2 primary services:

1. Financing Deduplication
2. Document Authenticity Verification

We will focus on doing a simple deduplication check here. All flows center around a deduplication check. Document authentication is optional and dependent on the availability of relevant trade utility services (sources of document authenticity data) for the supporting documents, used as evidence in the financing, in the geographic region the documents pertain to. This API is for usage only by the lenders in any financing transaction.

Note: The API is structured to be asynchronous

This means that POST requests will not respond with results, but will respond with a request identifier which must be used in a subsequent GET request to retrieve the results.

Business Process

1. Lender receives an application for financing
2. Lender registers the financing details and supporting documents in the API
3. Lender reviews the validation results
4. Lender makes a financing decision - Go/No Go
   • If Approved, Lender updates the registration as “Financed”
   • If Denied, Lender updates the registration as “Cancelled”

Order of API Requests for Happy Path

1. POST /registrations - Register your financing application
2. GET status/{request-identification} - Retrieve the results of your registration
3. POST /financings - Update your financing registration as ‘Financed’
4. GET status/{request-identification} - Verify your financing was successful

See Monitoring Activity and Polling for best practices on the /activity endpoint.

Next > Registrations