POST api/onfido/retrieve-references

Retrieves onfido references, including onfido applicant reference and attached check references

Request Information

URI Parameters

None.

Body Parameters

ERP.Api.Models.Onfido.Applicant

Name	Type	Additional information
first_name	string	None.
last_name	string	None.
dob	string	None.
email	string	None.
address	ERP.Api.Models.Onfido.Address	None.
id	string	None.

Request Formats

application/json, text/json

Sample:

{
  "first_name": "sample string 1",
  "last_name": "sample string 2",
  "dob": "sample string 3",
  "email": "sample string 4",
  "address": {
    "street": "sample string 1",
    "town": "sample string 2",
    "postcode": "sample string 3",
    "country": "sample string 4"
  },
  "id": "sample string 5"
}

application/xml, text/xml

Sample:

<Applicant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.Onfido">
  <address>
    <country>sample string 4</country>
    <postcode>sample string 3</postcode>
    <street>sample string 1</street>
    <town>sample string 2</town>
  </address>
  <dob>sample string 3</dob>
  <email>sample string 4</email>
  <first_name>sample string 1</first_name>
  <id>sample string 5</id>
  <last_name>sample string 2</last_name>
</Applicant>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ERP.Api.Models.Onfido.Applicant'.

Response Information

Resource Description

JSON string with front end compatible references object

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>