Create Compliance Profile

This operation allows you to create a compliance profile for a client in the system. This page will guide you through this process; see the following sections for more details.

🚧

Encrypted Requests

All requests into the stack are performed using the Encrypted Endpoint, where the request and response of the operation are encrypted. See How to Integrate Fondy API to learn how to encrypt your operations and send them through the endpoint.

Request

The request process of this operation consists of the following two steps:

  1. Create the payload
  2. Make the encrypted request

See the sections below for more details on each step.

Step 1: Create the Payload

The identity information must be sent to the payload. See the code block below for an example:

{
  "external_id": "ExampleRefId_43971e26-61b1-420b-9add-c510d44a354f",
  "profile_type": "SOLETRADER",
  "full_name": "string",
  "email": "string",
  "telephone": "string"
}

Where:

FieldDescription
external_idUnique reference ID for the profile.
profile_typeType of profile.
full_nameFull name of the individual or company.
emailEmail address of the individual or company.
telephoneTelephone number of the individual or company.

Once you create the payload it has to be encrypted, see the following section for more details.

Step 2: Make the encrypted request

To create a wallet under a split account, follow the steps below:

  1. Follow the steps in How to Integrate Fondy API to encrypt your request into the stack.
  2. Send the encrypted operation using Encrypted Endpoint. See an example in the code block below:
    {
        "encrypted_payload": ENCRYPTED(profileObject),
        "encrypted_user": ENCRYPTED(<username>),    
        "encrypted_url": ENCRYPTED("/onboarding/compliance/profile"),
        "method": "POST"
    }
    

In the request ENCRYPTED(identityObject) is the payload previously created, which is now encrypted.

Response

A successful request will return the encrypted response, as in the code block below:

{
    "encrypted_payload": ENCRYPTED(profileObject)
    "encrypted_url": null
    "method": null
    "nonce": null
}

This response has to be decrypted using the process explained in How to Integrate Fondy API. Once it is decrypted, the unencrypted payload is as follows:

{
  "id": "43971e26-61b1-420b-9add-c510d44a354f",
  "external_id": "ExampleRefId_43971e26-61b1-420b-9add-c510d44a354f",
  "external_url_validation": "string",
  "client_ref": "43971e26-61b1-420b-9add-c510d44a354f",
  "profile_type": "SOLETRADER",
  "full_name": "string",
  "email": "string",
  "telephone": "string",
  "status": "PENDING",
  "created_date": "2020-01-22T13:15:30Z",
  "linked_identities": [
    "43971e26-61b1-420b-9add-c510d44a354f"
  ]
}

Where:

FieldDescription
idUnique identifier for the created profile.
external_idReference ID for the profile, matches the one provided in the request.
external_url_validationURL used to validate the external ID (if applicable).
client_refClient reference ID associated with the profile.
profile_typeType of profile.
full_nameFull name of the individual or company associated with the profile.
emailEmail address associated with the profile.
telephoneTelephone number associated with the profile.
statusCurrent status of the profile.
created_dateTimestamp when the profile was created.
linked_identitiesList of linked identity IDs associated with the profile.