Skip to main content
POST
/
idvalidate
/
onboarding-url
Provide onboarding url for hosted onesdk
curl --request POST \
  --url https://api.uat.frankie.one/idv/v2/idvalidate/onboarding-url \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "applicationRef": "<string>",
  "channelRef": "<string>",
  "consent": true,
  "customerRef": "<string>",
  "entity": {
    "addresses": [
      {
        "addressId": "<string>",
        "addressType": "<string>",
        "buildingName": "<string>",
        "careOf": "<string>",
        "country": "<string>",
        "endDate": "<string>",
        "extraData": [
          {
            "kvpKey": "<string>",
            "kvpType": "<string>",
            "kvpValue": "<string>"
          }
        ],
        "longForm": "<string>",
        "postalCode": "<string>",
        "region": "<string>",
        "startDate": "<string>",
        "state": "<string>",
        "streetName": "<string>",
        "streetNumber": "<string>",
        "streetType": "<string>",
        "suburb": "<string>",
        "town": "<string>",
        "unitNumber": "<string>",
        "unstructuredLongForm": "<string>"
      }
    ],
    "dateOfBirth": {
      "country": "<string>",
      "dateOfBirth": "<string>",
      "locality": "<string>",
      "unstructuredDateOfBirth": "<string>",
      "yearOfBirth": "<string>"
    },
    "entityId": "<string>",
    "entityProfile": "<string>",
    "entityType": "<string>",
    "extraData": [
      {
        "kvpKey": "<string>",
        "kvpType": "<string>",
        "kvpValue": "<string>"
      }
    ],
    "flags": [
      {
        "flag": "<string>",
        "value": 123
      }
    ],
    "gender": "<string>",
    "identityDocs": [
      {
        "country": "<string>",
        "createdFromScan": true,
        "docScan": [
          {
            "ScanDelete": true,
            "scanCreated": "<string>",
            "scanData": "<string>",
            "scanDataRetrievalState": "<string>",
            "scanDocId": "<string>",
            "scanFilename": "<string>",
            "scanMIME": "<string>",
            "scanPageNum": 123,
            "scanSide": "<string>",
            "scanType": "<string>"
          }
        ],
        "documentId": "<string>",
        "documentStatus": "<string>",
        "extraData": [
          {
            "kvpKey": "<string>",
            "kvpType": "<string>",
            "kvpValue": "<string>"
          }
        ],
        "idExpiry": "<string>",
        "idIssued": "<string>",
        "idNumber": "<string>",
        "idSubType": "<string>",
        "idType": "<string>",
        "manuallyModified": true,
        "region": "<string>"
      }
    ],
    "name": {
      "displayName": "<string>",
      "familyName": "<string>",
      "givenName": "<string>",
      "honourific": "<string>",
      "middleName": "<string>"
    },
    "organisationData": {
      "adverseCreditDataPresent": true,
      "aliases": [
        "<string>"
      ],
      "blockingReasons": [
        {
          "candidates": [
            {
              "address": "<string>",
              "code": "<string>",
              "countryIso": "<string>",
              "registeredName": "<string>",
              "registryDescription": "<string>",
              "subdivision": "<string>"
            }
          ],
          "description": "<string>",
          "type": "<string>"
        }
      ],
      "class": {
        "code": "<string>",
        "description": "<string>"
      },
      "contactDetails": {
        "email": "<string>",
        "faxNumber": "<string>",
        "telephoneNumber": "<string>",
        "websiteURL": "<string>"
      },
      "disclosingEntityIndicator": true,
      "includesNonBeneficiallyHeld": true,
      "industryCodes": [
        {
          "code": "<string>",
          "description": "<string>"
        }
      ],
      "industryDeclarations": [
        {
          "description": "<string>",
          "language": "<string>"
        }
      ],
      "kycCustomerType": "<string>",
      "lastCheckDate": "<string>",
      "legalFormDetails": {
        "basis": "<string>",
        "capital": "<string>",
        "comments": "<string>",
        "control": "<string>",
        "incorp": "<string>",
        "partner": "<string>",
        "responsibility": "<string>",
        "stocks": "<string>"
      },
      "normalisedLegalStatus": "<string>",
      "ownershipResolved": true,
      "registeredName": "<string>",
      "registration": {
        "countryIso": "<string>",
        "date": "<string>",
        "number": "<string>",
        "previousNumber": "<string>",
        "registryCode": "<string>",
        "registryDescription": "<string>",
        "state": "<string>",
        "unstructuredDate": "<string>",
        "unstructuredFoundationDate": "<string>"
      },
      "registries": {
        "abr": {
          "abn": "<string>",
          "acn": "<string>",
          "addresses": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>",
              "postcode": "<string>",
              "stateCode": "<string>"
            }
          ],
          "businessNames": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>",
              "name": "<string>",
              "type": "<string>"
            }
          ],
          "charityEndorsements": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>",
              "type": "<string>"
            }
          ],
          "charityTypes": [
            {
              "description": "<string>",
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>"
            }
          ],
          "description": "<string>",
          "dgrEndorsements": [
            {
              "endorsedFrom": "<string>",
              "endorsedTo": "<string>"
            }
          ],
          "gst": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>"
            }
          ],
          "historicalChanges": [
            {
              "businessName": [
                "<string>"
              ],
              "date": "<string>",
              "entityStatus": [
                "<string>"
              ],
              "goodsAndServicesTax": [
                "<string>"
              ],
              "mainBusinessPhysicalAddress": [
                "<string>"
              ],
              "mainName": [
                "<string>"
              ],
              "mainTradingName": [
                "<string>"
              ]
            }
          ],
          "lastUpdated": "<string>",
          "name": "<string>",
          "registeredDate": "<string>",
          "status": "<string>",
          "statusEffectiveFrom": "<string>",
          "type": "<string>",
          "typeCode": "<string>",
          "updatedDate": "<string>"
        }
      },
      "reviewDate": "<string>",
      "shareStructure": [
        {
          "amountDue": 123,
          "amountPaid": 123,
          "classCode": "<string>",
          "classTitle": "<string>",
          "docNumber": "<string>",
          "docNumberQualifier": "<string>",
          "sharesIssued": 123,
          "status": "<string>"
        }
      ],
      "startDate": "<string>",
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "subType": {
        "code": "<string>",
        "description": "<string>"
      },
      "subclass": {
        "code": "<string>",
        "description": "<string>"
      },
      "type": {
        "code": "<string>",
        "description": "<string>"
      }
    }
  },
  "errorRedirectURL": "<string>",
  "flowId": "<string>",
  "messageTemplateId": "<string>",
  "phoneCode": "<string>",
  "phoneNumber": "+6140000000",
  "recipientName": "<string>",
  "requestedDocuments": [
    {
      "documentType": "<string>",
      "subType": "<string>"
    }
  ],
  "sendSMS": true,
  "senderName": "<string>",
  "successRedirectURL": "<string>"
}
'
{
  "entity": {
    "addresses": [
      {
        "addressId": "<string>",
        "addressType": "<string>",
        "buildingName": "<string>",
        "careOf": "<string>",
        "country": "<string>",
        "endDate": "<string>",
        "extraData": [
          {
            "kvpKey": "<string>",
            "kvpType": "<string>",
            "kvpValue": "<string>"
          }
        ],
        "longForm": "<string>",
        "postalCode": "<string>",
        "region": "<string>",
        "startDate": "<string>",
        "state": "<string>",
        "streetName": "<string>",
        "streetNumber": "<string>",
        "streetType": "<string>",
        "suburb": "<string>",
        "town": "<string>",
        "unitNumber": "<string>",
        "unstructuredLongForm": "<string>"
      }
    ],
    "dateOfBirth": {
      "country": "<string>",
      "dateOfBirth": "<string>",
      "locality": "<string>",
      "unstructuredDateOfBirth": "<string>",
      "yearOfBirth": "<string>"
    },
    "entityId": "<string>",
    "entityProfile": "<string>",
    "entityType": "<string>",
    "extraData": [
      {
        "kvpKey": "<string>",
        "kvpType": "<string>",
        "kvpValue": "<string>"
      }
    ],
    "flags": [
      {
        "flag": "<string>",
        "value": 123
      }
    ],
    "gender": "<string>",
    "identityDocs": [
      {
        "country": "<string>",
        "createdFromScan": true,
        "docScan": [
          {
            "ScanDelete": true,
            "scanCreated": "<string>",
            "scanData": "<string>",
            "scanDataRetrievalState": "<string>",
            "scanDocId": "<string>",
            "scanFilename": "<string>",
            "scanMIME": "<string>",
            "scanPageNum": 123,
            "scanSide": "<string>",
            "scanType": "<string>"
          }
        ],
        "documentId": "<string>",
        "documentStatus": "<string>",
        "extraData": [
          {
            "kvpKey": "<string>",
            "kvpType": "<string>",
            "kvpValue": "<string>"
          }
        ],
        "idExpiry": "<string>",
        "idIssued": "<string>",
        "idNumber": "<string>",
        "idSubType": "<string>",
        "idType": "<string>",
        "manuallyModified": true,
        "region": "<string>"
      }
    ],
    "name": {
      "displayName": "<string>",
      "familyName": "<string>",
      "givenName": "<string>",
      "honourific": "<string>",
      "middleName": "<string>"
    },
    "organisationData": {
      "adverseCreditDataPresent": true,
      "aliases": [
        "<string>"
      ],
      "blockingReasons": [
        {
          "candidates": [
            {
              "address": "<string>",
              "code": "<string>",
              "countryIso": "<string>",
              "registeredName": "<string>",
              "registryDescription": "<string>",
              "subdivision": "<string>"
            }
          ],
          "description": "<string>",
          "type": "<string>"
        }
      ],
      "class": {
        "code": "<string>",
        "description": "<string>"
      },
      "contactDetails": {
        "email": "<string>",
        "faxNumber": "<string>",
        "telephoneNumber": "<string>",
        "websiteURL": "<string>"
      },
      "disclosingEntityIndicator": true,
      "includesNonBeneficiallyHeld": true,
      "industryCodes": [
        {
          "code": "<string>",
          "description": "<string>"
        }
      ],
      "industryDeclarations": [
        {
          "description": "<string>",
          "language": "<string>"
        }
      ],
      "kycCustomerType": "<string>",
      "lastCheckDate": "<string>",
      "legalFormDetails": {
        "basis": "<string>",
        "capital": "<string>",
        "comments": "<string>",
        "control": "<string>",
        "incorp": "<string>",
        "partner": "<string>",
        "responsibility": "<string>",
        "stocks": "<string>"
      },
      "normalisedLegalStatus": "<string>",
      "ownershipResolved": true,
      "registeredName": "<string>",
      "registration": {
        "countryIso": "<string>",
        "date": "<string>",
        "number": "<string>",
        "previousNumber": "<string>",
        "registryCode": "<string>",
        "registryDescription": "<string>",
        "state": "<string>",
        "unstructuredDate": "<string>",
        "unstructuredFoundationDate": "<string>"
      },
      "registries": {
        "abr": {
          "abn": "<string>",
          "acn": "<string>",
          "addresses": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>",
              "postcode": "<string>",
              "stateCode": "<string>"
            }
          ],
          "businessNames": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>",
              "name": "<string>",
              "type": "<string>"
            }
          ],
          "charityEndorsements": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>",
              "type": "<string>"
            }
          ],
          "charityTypes": [
            {
              "description": "<string>",
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>"
            }
          ],
          "description": "<string>",
          "dgrEndorsements": [
            {
              "endorsedFrom": "<string>",
              "endorsedTo": "<string>"
            }
          ],
          "gst": [
            {
              "effectiveFrom": "<string>",
              "effectiveTo": "<string>"
            }
          ],
          "historicalChanges": [
            {
              "businessName": [
                "<string>"
              ],
              "date": "<string>",
              "entityStatus": [
                "<string>"
              ],
              "goodsAndServicesTax": [
                "<string>"
              ],
              "mainBusinessPhysicalAddress": [
                "<string>"
              ],
              "mainName": [
                "<string>"
              ],
              "mainTradingName": [
                "<string>"
              ]
            }
          ],
          "lastUpdated": "<string>",
          "name": "<string>",
          "registeredDate": "<string>",
          "status": "<string>",
          "statusEffectiveFrom": "<string>",
          "type": "<string>",
          "typeCode": "<string>",
          "updatedDate": "<string>"
        }
      },
      "reviewDate": "<string>",
      "shareStructure": [
        {
          "amountDue": 123,
          "amountPaid": 123,
          "classCode": "<string>",
          "classTitle": "<string>",
          "docNumber": "<string>",
          "docNumberQualifier": "<string>",
          "sharesIssued": 123,
          "status": "<string>"
        }
      ],
      "startDate": "<string>",
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "subType": {
        "code": "<string>",
        "description": "<string>"
      },
      "subclass": {
        "code": "<string>",
        "description": "<string>"
      },
      "type": {
        "code": "<string>",
        "description": "<string>"
      }
    }
  },
  "status": "<string>",
  "url": "<string>",
  "urlExpiry": "<string>"
}

Authorizations

​
api_key
string
header
required

API key issued by FrankieOne. This will rotate regularly

Headers

​
X-Frankie-CustomerID
string
required

Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time

​
X-Frankie-CustomerChildID
string

If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID. Note: If using a CustomerChildID, you will also need a separate api_key for each child. Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data. A Customer can see the documents/entities and checks of all their Children

​
X-Frankie-Channel
string

Open string that can be used to define the 'channel' the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated

Body

application/json

Details for generating the onboarding link

​
applicationRef
string

A specific reference id for this API call

​
channelRef
string

Used as a channel parameter to be sent to the IDV vendor

​
consent
boolean

Consent flag for when the customer collects this from an end-user can be set as 'true' or 'false'. The consent.general and consent.docs KVPs will also get attached to the new entity being created. Hence, If running flowId with OCR, this must be set to true, otherwise OCR will get an error.

​
customerRef
string

A customer reference or unique id that a customer would like to set for an end-user

​
entity
object
​
errorRedirectURL
string

If the end-user fails the process, the URL you would like to redirect the end-user to

​
flowId
string

there are different flowIds you can pass in depending on your use-case, please refer to the documentation for more information at 'https://apidocs.frankiefinancial.com/docs/using-hosted-onesdk' for more details

​
messageTemplateId
string

An id for the message template you want to send in the SMS. If you would like a custom template, please ask our support operations team

​
phoneCode
string

The country code to route the SMS to '+61' or '+66' for example

​
phoneNumber
string

The end-user's phone number. Phone code can be included with phone number or split out

Example:

"+6140000000"

​
recipientName
string

if supplied will be used as the recipient name for the SMS

​
requestedDocuments
object[]

Type of documents to be requested for a business entity. This will only be used for a specific flowId, please refer to the documentation for more information at 'https://apidocs.frankiefinancial.com/docs/using-hosted-onesdk' for more details

​
sendSMS
boolean

Toggle to determine whether generating a link will also send the SMS to the customer, can be set as 'true' or 'false'. If 'true' will send an SMS to the phone number supplied

​
senderName
string

Set the name of the Sender in the SMS

​
successRedirectURL
string

Set the URL to redirect upon success

Response

OK

​
entity
object
​
status
string
​
url
string
​
urlExpiry
string