Manage applications

Mansar offers a short, low-friction, non-documentary application process - most applications will be approved in under five seconds. In some cases, Mansar detects an exception in the application process (e.g. a phone number mismatch), and certain documents are required in order to make a decision.

Mansar will let you know exactly what documents to require from the customer, and once they are provided (via an API call), the application will either be approved automatically or manually reviewed by us (under an SLA of two business hours).

Application Statuses​

The final statuses for an application are Approved, Denied or Canceled. Once an application is approved, a Customer resource will be created and associated with the application resource. The newly created customer resources will be referenced in the relationships object.

In most cases, an application will reach one of these final statuses immediately after creation, without requiring any documents.

In some cases, documents will be required and the application will enter an AwaitingDocuments status. Once you upload all the required documents, Mansar will use the information provided to approve or deny the application. The decision may take seconds in some cases and up to two hours in other cases (when a manual review is required). Once the process is complete, you will receive a webhook containing the result.

An application can also be evaluated asynchronously, in which case its status will be Pending as long as the evaluation process is running. Once the process is complete, the status will change to either Approved, Denied or AwaitingDocuments and the relevant webhook event will be fired (see Pending status description below)

There is an option to Cancel Application at any point that is not Approved or Denied. The status of the application will change to Canceled, and the relevant webhook event will be fired.

Below is a diagram describing the lifecycle of an application:

Below are all application statuses and their descriptions:

Status	Description
AwaitingDocuments	Certain documents are required for the process to continue. You may upload them via Upload Document.
PendingReview	The application is pending review by Mansar (with an SLA of 2 business hours).
Pending	The application is being evaluated asynchronously and a result should be available shortly. Listen for webhooks (application.denied, customer.created) and application.awaitingdocuments) for the final result, or periodically query the application with Get by Id).
Approved	The application was approved. A Customer resource was created.
Denied	The application was denied. A Customer resource will not be created.
Canceled	The application was сanceled. A Customer resource will not be created.

Device Fingerprints​

A Device fingerprint is a way to combine certain attributes of a device (operating system, IP address, device language settings etc.) in order to identify unique devices.

Mansar partners with select providers to detect and prevent potential fraud. To enjoy improved protection, you must add the device fingerprint to new application.

Providers​

Name
OKTA

Create Individual Application​

Create an application for an individual end-customer.

INFO

The ID number is used as the unique identifier for an individual on Mansar. The same identifier cannot be used to submit multiple applications. If an application for a certain individual has been denied, canceled, or archived, they may use their National ID/passport number to reapply. Otherwise, duplicate applications will result in an HTTP error (400).

Verb	POST
Url	https://api.s.usemansar.xyz/applications
Required Scope	applications-write
Data Type	individualApplication
Timeout (Seconds)	120

Attributes​

Name	Type	Description
ssn	string	ID of the individual (numbers only). Either an national IDor passport is required.
passport/National ID	string	National ID or Passport number of the individual.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID. Two letters representing the individual nationality. (e.g. "CM").
fullName	FullName	Full name of the individual.
dateOfBirth	RFC3339 Date string	Date only (e.g. "2001-08-15").
address	Address	Address of the individual. Must be a local address.
phone	Phone	Phone number of the individual.
email	string	Email address of the individual.
evaluationParams	EvaluationParams	Optional. Evaluation Params for this entity.
occupation	Occupation	Occupation of the individual.
annualIncome	AnnualIncome	Annual income of the individual.
sourceOfIncome	SourceOfIncome	Source of income of the individual.
ip	string	Optional. IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application.
tags	object	Optional. Tags that will be copied to the customer that this application creates.
idempotencyKey	string	Optional.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention
jwtSubject	string	Optional.

Example Request:

curl -X POST 'https://api.s.usemansar.xyz/applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "ID": "721074426",
      "fullName": {
        "first": "Mansa",
        "last": "Hotep"
      },
      "dateOfBirth": "2000-08-10",
      "address": {
        "street": "Avenue Bonapriso",
        "city": "Douala",
        "region": "LT",
        "postalCode": "11375",
        "country": "CM"
      },
      "email": "[email protected]",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "ip": "127.0.0.2",
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between50kAnd100k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response​

Response is a JSON:API document.

201 Created​

Field	Type	Description
data	IndividualApplication	The newly created resource.
included	Array of ApplicationDocument Resource	Required documents for this application. Each document resource includes the document status.

Example Response:

{
  "data": {
    "type": "individualApplication",
    "id": "53",
    "attributes": {
      "createdAt": "2024-01-14T14:05:04.718Z",
      "fullName": {
        "first": "Mansa",
        "last": "Hotep"
      },
      "ID": "721074426",
      "address": {
        "street": "Avenue Bonapriso",
        "city": "Douala",
        "region": "LT",
        "postalCode": "11375",
        "country": "CM"
        
        
      },
      "dateOfBirth": "2000-08-10",
      "email": "[email protected]",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "status": "AwaitingDocuments",
      "ip": "127.0.0.2",
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between50kAnd100k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "soleProprietorship": false,
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "archived": false
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
        "street": "Avenue Bonapriso",
        "city": "Douala",
        "region": "LT",
        "postalCode": "11375",
        "country": "CM"
        }
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
        "dateOfBirth": "2000-08-10"
      }
    }
  ]
}

Create Sole Proprietor Application​

Create an application for a sole proprietor.

INFO

A sole proprietorship is a type of enterprise owned and run by one person, and in which there is no legal distinction between the owner and the business entity. As such, it is evaluated as an individual, with the soleProprietorship attribute set to true

INFO

The ID is used as the unique identifier for an individual on Mansar. The same identifier cannot be used to submit multiple applications. If an application for a certain individual has been denied, canceled, or archived, they may use their national ID/passport number to reapply. Otherwise, duplicate applications will result in an HTTP error (400).

Verb	POST
Url	https://api.s.usemansar.xyz/applications
Required Scope	applications-write
Data Type	individualApplication
Timeout (Seconds)	120

Attributes​

Name	Type	Description
ID	string	ID of the individual (numbers only). Either an national ID or passport is required.
ID	string	National ID or Passport number of the individual. Either a national IDor passport number is required.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID. Two letters representing the individual nationality. (e.g. "CM").
fullName	FullName	Full name of the individual.
dateOfBirth	RFC3339 Date string	Date only (e.g. "2001-08-15").
address	Address	Address of the individual. Must be a local address.
phone	Phone	Phone number of the individual.
email	string	Email address of the individual.
soleProprietorship	boolean	Set this to true in order to indicate that the individual is a sole proprietor.
ein	string	Optional. If the individual is a sole proprietor who has an Employer Identification Number, specify it here. Not all sole proprietors have an EIN, so this attribute is optional, even when soleProprietorship is set to true.
dba	string	Optional. If the individual is a sole proprietor who is doing business under a different name, specify it here. This attribute is optional, even when soleProprietorship is set to true.
evaluationParams	EvaluationParams	Optional. Evaluation Params for this entity.
annualRevenue	AnnualRevenue	For sole proprietors, specify the annual revenue here.
numberOfEmployees	NumberOfEmployees	For sole proprietors, specify the number of employees here.
businessVertical	BusinessVertical	For sole proprietors, specify the business vertical here.
website	string	A Valid website Url. Providing a null value is indicative of the business customer attesting that they do not have a website.
ip	string	Optional. IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application.
tags	object	Optional. Tags that will be copied to the customer that this application creates.
idempotencyKey	string	Optional.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention.
jwtSubject	string	Optional.

Example Request:

curl -X POST 'https://api.s.usemansar.xyz/applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "ID": "721074426",
      "fullName": {
        "first": "Peter",
        "last": "Parker"
      },
      "dateOfBirth": "2001-08-10",
      "address": {
        "street": "20 Ingram St",
        "city": "Forest Hills",
        "region": "LT",
        "postalCode": "11375",
        "country": "CM"
      },
      "email": "[email protected]",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "ip": "127.0.0.2",
      "soleProprietorship": true,
      "ein": "123456789",
      "dba": "Piedpiper Inc",
      "businessVertical": "TechnologyMediaOrTelecom",
      "numberOfEmployees": "Between5And10",
      "website": "https://www.piedpiper.com",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response​

Response is a JSON:API document.

201 Created​

Field	Type	Description
data	IndividualApplication	The newly created resource.
included	Array of ApplicationDocument Resource	Required documents for this application. Each document resource includes the document status.

Example Response:

{
  "data": {
    "type": "individualApplication",
    "id": "53",
    "attributes": {
      "createdAt": "2020-01-14T14:05:04.718Z",
      "fullName": {
        "first": "Peter",
        "last": "Parker"
      },
      "ID": "721074426",
      "address": {
        "street": "20 Ingram St",
        "street2": null,
        "city": "Forest Hills",
        "region": "LT",
        "postalCode": "11375",
        "country": "CM"
      },
      "dateOfBirth": "2001-08-10",
      "email": "[email protected]",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "status": "AwaitingDocuments",
      "ip": "127.0.0.2",
      "soleProprietorship": true,
      "ein": "123456789",
      "dba": "Piedpiper Inc",
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between50kAnd100k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "annualRevenue": "Between100kAnd200k",
      "numberOfEmployees": "Between5And10",
      "businessVertical": "TechnologyMediaOrTelecom",
      "website": "https://www.piedpiper.com",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "archived": false
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Forest Hills",
          "region": "LT",
          "postalCode": "11375",
          "country": "CM"
        }
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
        "dateOfBirth": "2001-08-10"
      }
    }
  ]
}

Create Business Application​

Create an application for a business end-customer.

Verb	POST
Url	https://api.s.usemansar.xyz/applications
Required Scope	applications-write
Data Type	businessApplication
Timeout (Seconds)	120

Attributes​

Name	Type	Description
name	string	Name of the business.
dba	string	Optional. "Doing business as".
address	Address	Address of the business. Must be a local address
phone	Phone	Phone number of the business.
countryOfIncorporation	string	Two letters representing a coutnry
ein	string	Business EIN (numbers only).
entityType	string	One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization.
website	string	A Valid website Url. Providing a null value is indicative of the business customer attesting that they do not have a website.
contact	BusinessContact	Primary contact of the business. This person is the one that will have access to the account.
officer	Officer	Officer representing the business (must be the CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member). To onboard a business successfully, you must provide the officer's personal details.
beneficialOwners	Array of BeneficialOwner	Array of beneficial owners in the business. Beneficial owners are all people that, directly or indirectly, own 25% or more of the business. To onboard a business successfully, you must provide each beneficial owner's personal details. If the business has no beneficial owners, the array should be empty.
annualRevenue	AnnualRevenue	Required if any of the officer / BeneficialOwner of the business have a non US nationality. Annual revenue of the business.
numberOfEmployees	NumberOfEmployees	Required if any of the officer / BeneficialOwner of the business have a non US nationality. Number of employees of the business.
cashFlow	CashFlow	Required if any of the officer / BeneficialOwner of the business have a non US nationality. Cash flow of the business.
yearOfIncorporation	Year string	Year of incorporation of the business.
countriesOfOperation	Array of ISO31661-Alpha2 strings	Required if any of the officer / BeneficialOwner of the business have a non US nationality. An array of two letter codes representing the countries of operation of the business.
stockSymbol	string	Optional. The stock symbol (ticker) of the business.
businessVertical	BusinessVertical	The business vertical of the business.
ip	string	Optional. IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application.
tags	object	Optional. Tags that will be copied to the customer that this application creates.
idempotencyKey	string	Optional.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention.

Example Request:

curl -X POST 'https://api.s.usemansar.xyz/applications'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "businessApplication",
    "attributes": {
      "name": "Pied Piper",
      "address": {
        "street": "5230 Newell Rd",
        "city": "Douala",
        "region": "LT",
        "postalCode": "94303",
        "country": "CM"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "stateOfIncorporation": "DE",
      "ein": "123456789",
      "entityType": "Corporation",
      "ip": "127.0.0.2",
      "annualRevenue": "Between500kAnd1m",
      "numberOfEmployees": "Between50And100",
      "cashFlow": "Predictable",
      "yearOfIncorporation": "2014",
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "stockSymbol": "PPI",
      "businessVertical": "TechnologyMediaOrTelecom",
      "website": "https://www.piedpiper.com",
      "contact": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "email": "[email protected]",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        }
      },
      "officer": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "dateOfBirth": "2001-08-10",
        "title": "CEO",
        "ssn": "721074426",
        "email": "[email protected]",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "address": {
          "street": "5230 Newell Rd",
          "city": "Douala",
          "region": "LT",
          "postalCode": "94303",
          "country": "CM"
        },
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between50kAnd100k",
        "sourceOfIncome": "EmploymentOrPayrollIncome"
      },
      "beneficialOwners": [
        {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "dateOfBirth": "2001-08-10",
          "ssn": "123456789",
          "email": "[email protected]",
          "percentage": 75,
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          },
          "address": {
            "street": "5230 Newell Rd",
            "city": "Douala",
            "region": "LT",
            "postalCode": "94303",
            "country": "CM"
          },
          "occupation": "ArchitectOrEngineer",
          "annualIncome": "Between50kAnd100k",
          "sourceOfIncome": "EmploymentOrPayrollIncome"
        }
      ],
      "tags": {
        "userId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Response​

Response is a JSON:API document.

201 Created​

Field	Type	Description
data	BusinessApplication	The newly created resource.
relationships	JSON:API Relationships	Describes relationships between the application resource and other resources (beneficial owners).
included	Array of ApplicationDocument Resource or BeneficialOwner Resource	Required documents for this application. Each document resource includes the document status. List of the application's beneficial owners.

Example Response:

{
  "data": {
    "type": "businessApplication",
    "id": "50",
    "attributes": {
      "createdAt": "2020-01-13T16:01:19.346Z",
      "name": "Pied Piper",
      "dba": null,
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Douala",
        "region": "LT",
        "postalCode": "94303",
        "country": "CM"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "stateOfIncorporation": "DE",
      "ein": "123456789",
      "entityType": "Corporation",
      "ip": "127.0.0.2",
      "website": "https://www.piedpiper.com",
      "annualRevenue": "Between500kAnd1m",
      "numberOfEmployees": "Between50And100",
      "cashFlow": "Predictable",
      "yearOfIncorporation": "2014",
      "countriesOfOperation": [
        "US",
        "CA"
      ],
      "stockSymbol": "PPI",
      "businessVertical": "TechnologyMediaOrTelecom",
      "contact": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "email": "[email protected]",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        }
      },
      "officer": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "ssn": "123456789",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Douala",
          "region": "LT",
          "postalCode": "94303",
          "country": "CM"
        },
        "dateOfBirth": "2001-08-10",
        "title": "CEO",
        "email": "[email protected]",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between50kAnd100k",
        "sourceOfIncome": "EmploymentOrPayrollIncome",
        "status": "Approved"
      },
      "beneficialOwners": [
        {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "ssn": "123456789",
          "address": {
            "street": "5230 Newell Rd",
            "street2": null,
            "city": "Douala",
            "region": "LT",
            "postalCode": "94303",
            "country": "CM"
          },
          "dateOfBirth": "2001-08-10",
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          },
          "email": "[email protected]",
          "percentage": 75,
          "status": "Approved"
        }
      ],
      "tags": {
        "userId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
      },
      "archived": false,
      "status": "AwaitingDocuments"
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          },
          {
            "type": "document",
            "id": "3"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "CertificateOfIncorporation",
        "status": "Required",
        "name": "Pied Piper",
        "description": "For Corporation: Please provide a certified copy of the Articles of Incorporation or Certificate of Incorporation..."
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Richard Hendricks",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Douala",
          "region": "LT",
          "postalCode": "94303",
          "country": "CM"
        }
      }
    },
    {
      "type": "document",
      "id": "3",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "name": "Richard Hendricks",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID."
      }
    }
  ]
}

Get by Id​

Get an application resource by id.

Verb	GET
Url	https://api.s.usemansar.xyz/applications/{id}
Required Scope	applications
Timeout (Seconds)	5

Response​

Response is a JSON:API document.

200 OK​

Field	Type	Description
data	IndividualApplication or BusinessApplication	Application resource. Can be business or individual, as indicated by the type field.
included	Array of ApplicationDocument Resource or BeneficialOwner Resource	Required documents for this application. Each document resource includes the document status. List of the application's beneficial owners.

curl -X GET 'https://api.s.usemansar.xyz/applications/43' \
-H "Authorization: Bearer ${TOKEN}"

List​

List application resources. Paging can be applied.

Verb	GET
Url	https://api.s.usemansar.xyz/applications
Required Scope	applications
Timeout (Seconds)	5

Query Parameters​

Name	Type	Default	Description
page[limit]	integer	100	Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Optional. Number of resources to skip. See Pagination.
filter[query]	string	(empty)	Optional. Search term according to the Full-Text Search Rules.
filter[status][]	string	(empty)	Optional. Filter applications by Application Status. Usage example: filter[status][0]=Pending&filter[status][1]=Approved
filter[email]	string	(empty)	Optional. Filter applications by email address (case sensitive).
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Applications by Tags.
sort	string	sort=-createdAt	Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order.

curl -X GET 'https://api.s.usemansar.xyz/applications?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Response​

Response is a JSON:API document.

200 OK​

Field	Type	Description
data	Array of IndividualApplication or BusinessApplication	Array of application resources. Each resource can be business or individual, as indicated by the type field.
meta	JSON object that contains pagination data	Pagination data includes offset, limit and total (total items).

Example Response:

{
  "data": [
    {
      "type": "individualApplication",
      "id": "1",
      "attributes": {
        "createdAt": "2020-01-15T13:47:36.098Z",
        "fullName": {
          "first": "Peter",
          "last": "Parker"
        },
        "ssn": "721074426",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Douala",
          "region": "LT",
          "postalCode": "11375",
          "country": "CM"
        },
        "dateOfBirth": "2001-08-10",
        "email": "[email protected]",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "status": "AwaitingDocuments",
        "archived": false,
        "message": "Waiting for you to upload the required documents."
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "documents": {
          "data": [
            {
              "type": "document",
              "id": "1"
            },
            {
              "type": "document",
              "id": "2"
            }
          ]
        }
      }
    },
    {
      "type": "businessApplication",
      "id": "2",
      "attributes": {
        "createdAt": "2020-01-15T13:48:38.527Z",
        "name": "Pied Piper",
        "dba": null,
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Douala",
          "region": "LT",
          "postalCode": "94303",
          "country": "CM"
        },
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "stateOfIncorporation": "DE",
        "ein": "123456789",
        "entityType": "Corporation",
        "contact": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "email": "[email protected]",
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          }
        },
        "officer": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "ssn": "123456789",
          "address": {
            "street": "5230 Newell Rd",
            "street2": null,
            "city": "Douala",
            "region": "LT",
            "postalCode": "94303",
            "country": "CM"
          },
          "dateOfBirth": "2001-08-10",
          "email": "[email protected]",
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          },
          "status": "Approved"
        },
        "beneficialOwners": [
          {
            "fullName": {
              "first": "Richard",
              "last": "Hendricks"
            },
            "ssn": "123456789",
            "address": {
              "street": "5230 Newell Rd",
              "street2": null,
              "city": "Douala",
              "region": "LT",
              "postalCode": "94303",
              "country": "CM"
            },
            "dateOfBirth": "2001-08-10",
            "phone": {
              "countryCode": "1",
              "number": "5555555555"
            },
            "email": "[email protected]",
            "status": "Approved"
          }
        ],
        "archived": false,
        "status": "AwaitingDocuments",
        "message": "Waiting for you to upload the required documents."
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "documents": {
          "data": [
            {
              "type": "document",
              "id": "1"
            },
            {
              "type": "document",
              "id": "2"
            },
            {
              "type": "document",
              "id": "3"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "limit": 100,
      "offset": 0
    }
  }
}

Update Business​

Update a business application.

NOTE

Tags that are updated after the application has been approved will not be inherited by the corresponded customer resource.

Verb	PATCH
Url	https://api.s.usemansar.xyz/applications/:id
Required Scope	applications-write
Timeout (Seconds)	5

Attributes​

Name	Type	Description
tags	object	See Updating Tags.
annualRevenue	AnnualRevenue	Optional. Annual revenue of the business.
numberOfEmployees	NumberOfEmployees	Optional. Number of employees of the business.
cashFlow	CashFlow	Optional. Cash flow of the business.
yearOfIncorporation	Year string	Optional. Year of incorporation of the business.
countriesOfOperation	Array of ISO31661-Alpha2 strings	Optional. An array of two letter codes representing the countries of operation of the business.
stockSymbol	string	Optional. The stock symbol (ticker) of the business.
website	string	Optional. A Valid website Url.
businessVertical	BusinessVertical	Optional. The business vertical of the business.

Response​

Response is a JSON:API document.

200 OK​

Field	Type	Description
data	BusinessApplication	The updated BusinessApplication resource.
relationships	JSON:API Relationships	Describes relationships between the application resource and other resources (beneficial owners).
included	Array of ApplicationDocument Resource or BeneficialOwner Resource	Required documents for this application. Each document resource includes the document status. List of the application's beneficial owners.

Update business application:

curl -X PATCH 'https://api.s.usemansar.xyz/application/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "businessApplication",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      },
      "annualRevenue": "Between500kAnd1m",
      "numberOfEmployees": "Between50And100",
      "cashFlow": "Predictable",
      "yearOfIncorporation": "2014",
      "countriesOfOperation": [
        "CM",
        "CE"
      ],
      "stockSymbol": "PPI",
      "businessVertical": "TechnologyMediaOrTelecom"
    }
  }
}'

Update Business Officer​

Update a business application's officer.

Verb	PATCH
Url	https://api.s.usemansar.xyz/applications/:id
Required Scope	applications-write
Timeout (Seconds)	5

Attributes​

Name	Type	Description
officer.occupation	Occupation	Optional. Occupation of the officer.
officer.annualIncome	AnnualIncome	Optional. Annual income of the officer.
officer.sourceOfIncome	SourceOfIncome	Optional. Source of income of the officer.

Response​

Response is a JSON:API document.

200 OK​

Field	Type	Description
data	BusinessApplication	The updated BusinessApplication resource.
relationships	JSON:API Relationships	Describes relationships between the application resource and other resources (beneficial owners).
included	Array of ApplicationDocument Resource or BeneficialOwner Resource	Required documents for this application. Each document resource includes the document status. List of the application's beneficial owners.

Update business application officer:

curl -X PATCH 'https://api.s.usemansar.xyz/application/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "businessApplication",
    "attributes": {
      "officer": {
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between10kAnd25k",
        "sourceOfIncome": "EmploymentOrPayrollIncome"
      }
    }
  }
}'

Update Business Beneficial Owner​

Update a business application's beneficial owner. The application id associated with the beneficial owner must be passed as a relationship in the request body.

Verb	PATCH
Url	https://api.s.usemansar.xyz/beneficial-owner/:id
Required Scope	applications-write
Timeout (Seconds)	5

Attributes​

Name	Type	Description
occupation	Occupation	Optional. Occupation of the beneficial owner.
annualIncome	AnnualIncome	Optional. Annual income of the beneficial owner.
sourceOfIncome	SourceOfIncome	Optional. Source of income of the beneficial owner.

Response​

Response is a JSON:API document.

200 OK​

Field	Type	Description
data	BeneficialOwner	The updated BeneficialOwner resource.

Update business application beneficial owner:

curl -X PATCH 'https://api.s.usemansar.xyz/beneficial-owner/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "beneficialOwner",
    "attributes": {
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between10kAnd25k",
      "sourceOfIncome": "EmploymentOrPayrollIncome"
    },
    "relationships": {
      "application": {
        "data": {
          "type": "businessApplication",
          "id": "10001"
        }
      }
    }
  }
}'

Update Individual​

Update an individual application.

NOTE

Tags that are updated after the application has been approved will not be inherited by the corresponded customer resource.

Verb	PATCH
Url	https://api.s.usemansar.xyz/applications/:id
Required Scope	applications-write
Timeout (Seconds)	5

Attributes​

Name	Type	Description
tags	object	See Updating Tags.
occupation	Occupation	Optional. Occupation of the individual.
annualIncome	AnnualIncome	Optional. Annual income of the individual.
sourceOfIncome	SourceOfIncome	Optional. Source of income of the individual.

Response​

Response is a JSON:API document.

200 OK​

Field	Type	Description
data	IndividualApplication	The updated IndividualApplication resource.

Update individual application:

curl -X PATCH 'https://api.s.usemansar.xyz/application/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      },
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between10kAnd25k",
      "sourceOfIncome": "EmploymentOrPayrollIncome"
    }
  }
}'

Update Sole Proprietor​

Update a sole-proprietorship application.

NOTE

Tags that are updated after the application has been approved will not be inherited by the corresponding customer resource.

Verb	PATCH
Url	https://api.s.usemansar.xyz/applications/:id
Required Scope	applications-write
Timeout (Seconds)	5

Attributes​

Name	Type	Description
tags	object	See Updating Tags.
annualRevenue	AnnualRevenue	Optional. Specify the annual revenue here.
numberOfEmployees	NumberOfEmployees	Optional. Specify the number of employees here.
businessVertical	BusinessVertical	Optional. Specify the business vertical here.
website	string	Optional. Specify the business website here.

Response​

Response is a JSON:API document.

200 OK​

Field	Type	Description
data	IndividualApplication	The updated IndividualApplication resource.

Update sole-proprietor application:

curl -X PATCH 'https://api.s.usemansar.xyz/application/:id'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      },
      "annualRevenue": "UpTo50k",
      "numberOfEmployees": "Between2And5",
      "businessVertical": "BusinessSupportOrBuildingServices",
      "website": "https://usemansar.xyz"
    }
  }
}'

Testing Applications​

By default, applications in Sandbox are approved immediately. In order to test the various flows (decline, manual review, required documents), Mansar provides simulations that allow you to control the application results.

You may trigger a decline or a flow that requires documents, by providing specific ID numbers that trigger each scenario.

In order to test flows that involve manual intervention, you may use dedicated endpoints that simulate the manual review results.