RYryftpay
Persons

Creates a new person under the account, for verification of Businesses

Changed on

This is for creating persons under your or your sub accounts account, required for verification of businesses. The following limits apply: - Maximum of 9 persons - Maximum of 5 persons with a role of Director - Maximum of 4 persons with a role of UltimateBeneficialOwner - Maximum of 1 person with a role of BusinessContact

post/accounts/{id}/persons

Request

  • Base URL
    https://sandbox-api.ryftpay.com/v1
  • URL
    https://sandbox-api.ryftpay.com/v1/accounts/{id}/persons
  • Auth
    API key in header Authorization

Path parameters

idstring required
Example:ac_b83f2653-06d7-44a9-a548-5825e8186004

the account id of one of your sub accounts

Request body

firstNamestring

The first name of the person

middleNamesstring nullable

The middle names of the person

lastNamestring

The last name / surname of the person

emailstring email

The email address of the person

dateOfBirthstring

The date of birth of the person, in format YYYY-MM-DD

countryOfBirthstring nullable

The two-character ISO 3166 country code of birth of the person

gender'Female' | 'Male'

The gender of the person. International regulations require either Female or Male

nationalitiesstring[]

The countries of citizenship or nationality of the person

phoneNumberstring

The phone number of the person, in E.164 format

businessRolesBusinessRole[]

The role(s) in the business that the person performs. This must contain at least one value.

metadataobject nullable

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

Example request

{
  "firstName": "Fred",
  "middleNames": "David",
  "lastName": "Jones",
  "email": "fred.jones@example.com",
  "dateOfBirth": "1990-01-20",
  "countryOfBirth": "GB",
  "gender": "Male",
  "nationalities": [
    "GB"
  ],
  "address": {
    "lineOne": "123 Test Street",
    "city": "Manchester",
    "country": "GB",
    "postalCode": "SP4 7DE"
  },
  "phoneNumber": "+447900000000",
  "businessRoles": [
    "BusinessContact",
    "Director"
  ],
  "documents": [
    {
      "type": "BankStatement",
      "front": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
      "back": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ"
    }
  ],
  "metadata": {
    "accountId": "1"
  }
}

Response

The person was created successfully

idstring

The ID of the person

firstNamestring

The first name of the person

middleNamesstring nullable

The middle names of the person

lastNamestring

The last name / surname of the person

emailstring email nullable

The email address of the person

dateOfBirthstring

The date of birth of the person, in format YYYY-MM-DD

countryOfBirthstring nullable

The two-character ISO 3166 country code of birth of the person

gender'Female' | 'Male' nullable

The gender of the person. International regulations require either Female or Male

nationalitiesstring[]

The countries of citizenship or nationality of the person

phoneNumberstring nullable

The phone number of the person, in E.164 format

businessRolesBusinessRole[]

The role(s) in the business that the person performs

metadataobject nullable

use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata.

createdTimestampinteger

The epoch timestamp (seconds) when the person was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the person was last updated

Example response

{
  "id": "per_01G0EYVFR02KBBVE2YWQ8AKMGJ",
  "firstName": "Fred",
  "middleNames": "David",
  "lastName": "Jones",
  "email": "fred.jones@example.com",
  "dateOfBirth": "1990-01-20",
  "countryOfBirth": "GB",
  "gender": "Male",
  "nationalities": [
    "GB"
  ],
  "address": {
    "lineOne": "123 Test Street",
    "city": "Manchester",
    "country": "GB",
    "postalCode": "SP4 7DE"
  },
  "phoneNumber": "+447900000000",
  "businessRoles": [
    "BusinessContact",
    "Director"
  ],
  "verification": {
    "status": "Required",
    "requiredFields": [
      {
        "name": "phoneNumber"
      }
    ],
    "requiredDocuments": [
      {
        "category": "ProofOfIdentity",
        "types": [
          "BankStatement"
        ],
        "quantity": 1
      }
    ],
    "errors": [
      {
        "code": "InvalidDocument",
        "id": "fl_01HAAHFQKEF4V7S6H3BTA3H85G",
        "description": "File corrupted or image not clear"
      }
    ]
  },
  "documents": [
    {
      "type": "BankStatement",
      "category": "ProofOfIdentity",
      "front": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
      "back": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
      "status": "Pending",
      "invalidReason": "Document has expired",
      "country": "GB",
      "assignedTimestamp": 1470989538,
      "lastUpdatedTimestamp": 1470989538
    }
  ],
  "metadata": {
    "accountId": "1"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Changes

  • 3269916e9b10Revision changes
    • breaking

      removed from the ////////// request property anyOf list

    • info

      added to the ////////// request property anyOf list