Global ID Verification (eidv/KYC)

Request

Method: POST

URL: https://{{environment}}.ridx.io/international-kyc

Headers

Header	Value
Content-Type	application/json
token	{{access_token}}

Request Body

Property	Type	Description
countryCode	String	ISO 3166-1 Alpha-2 complient country code, for example: AU, refer to description above for full list of supported countries
nationalid	String	Optional. The national ID of the person being searched, relevant to the country of the search. Only required when using these country codes: BR, CA, CN, EG, ES, HK, IN, IT, JO, JP, KW, MX, MY, OM, RO, RU, SA, SG, TR, US, ZA
phone	Object	Optional. The phone number of the person being searched, relevant to the country of the search. Requires three string properties; phone_number, calling_from and international_prefix. Only required when using these country codes: CA

Important Response Data

Property	Type	Description
completename	String	Full name of the person verified
givenfullname	String	Given (first) name of the person
surname_first	String	Surname (last name) of the person
nationalid	String	National ID as submitted in the request
dob	String	Date of birth, format: DD/MM/YYYY
countryCode	String	ISO 3166-1 Alpha-2 country code
gender	String	Gender of the person
nationality	String	Nationality of the person
passport	String	Passport number
codes	Object	Object containing verification codes and match details
codes.reliability	String	Reliability score indicating match quality: 10 (Full Match), 20 (Partial Match), 30 (No Match)
codes.adaptation	String	Adaptation score
codes.detailCode	String	Unique detail code for the verification request
codes.options	String	Options used during verification
codes.messages	Array	Array of message objects containing verification detail codes and match codes
codes.messages[].code	String	Message code identifier (e.g. Codes, MatchCodes, 1MT-AU-MATCHED-1+1)
codes.messages[].value	String	Message value
Status	String	Overall verification status: Full Match, Partial Match, No Match, or Request Error
rapidID	String	Unique RapidID check identifier
error	String	Error message, only present when the request is invalid

Example Requests

Example Request ( Score = 10 )Example Request ( Score = 20 )Example Request ( Score = 30 )Example Request ( Score = 0 )Example Request ( phone )Example Request ( Error response )

{
  "countryCode": "US",
  "address": {
    "addressLine1": "Av 55",
    "locality": "BARRETOS",
    "postCode": "14780490",
    "province": "SP"
  },
  "identity": {
    "dob": "1987-08-08",
    "firstName": "Adalgisa",
    "lastName": "Nery",
    "nationalid": "32698687827"
  }
}

{
  "countryCode": "US",
  "address": {
    "addressLine1": "Av 55",
    "locality": "BARRETOS",
    "postCode": "14780490",
    "province": "SP"
  },
  "identity": {
    "dob": "1987-08-08",
    "firstName": "Adalgisa",
    "lastName": "Nery",
    "nationalid": "11111111"
  }
}

{
  "countryCode": "US",
  "address": {
    "addressLine1": "Av 55",
    "locality": "BARRETOS",
    "postCode": "14780490",
    "province": "SP"
  },
  "identity": {
    "dob": "1987-08-08",
    "firstName": "Adalgisa",
    "lastName": "Nery",
    "nationalid": "22222222"
  }
}

{
  "countryCode": "US",
  "address": {
    "addressLine1": "Av 55",
    "locality": "BARRETOS",
    "postCode": "14780490",
    "province": "SP"
  },
  "identity": {
    "dob": "1987-08-08",
    "firstName": "Adalgisa",
    "lastName": "Nery",
    "nationalid": "99999999"
  }
}

{
  "countryCode": "CA",
  "address": {
    "addressLine1": "Av 55",
    "locality": "BARRETOS",
    "postCode": "14780490",
    "province": "SP"
  },
  "identity": {
    "dob": "1987-08-08",
    "firstName": "Adalgisa",
    "lastName": "Nery",
    "nationalid": "22222222"
  },
  "phone": {
    "phone_number": "0499999999",
    "calling_from": "CA",
    "international_prefix": "+1"
  }
}

{
  "countryCode": "US",
  "address": {
    "addressLine1": "Av 55",
    "locality": "BARRETOS",
    "postCode": "14780490",
    "province": "SP"
  },
  "identity": {
    "dob": "1987-08-08",
    "firstName": "Adalgisa",
    "nationalid": "32698687827"
  }
}

Example Responses

Success response ( Score = 10 )Success response ( Score = 20 )Success response ( Score = 30 )Failed response ( Score = 0 )Success response ( phone )Error Response

Status: 200 OK

{
  "completename": "Adalgisa Nery",
  "formofaddress": "",
  "qualificationpreceding": "",
  "givenfullname": "Adalgisa",
  "givennameinitials": "",
  "qualification_int_first": "",
  "surname_prefix_first": "",
  "surname_first": "Nery",
  "indicator": "",
  "qualification_int_second": "",
  "surname_prefix_second": "",
  "qualification_suceeding": "",
  "name_qualified": "",
  "function": "",
  "gender": "",
  "nationality": "",
  "nationalid": "32698687827",
  "organization_name": "",
  "dob": "08/08/1987",
  "businessid": "",
  "contact_type": "",
  "countryCode": "US",
  "passport": "",
  "codes": {
    "reliability": "10",
    "adaptation": "0",
    "detailCode": "WS-333865.2020.0.1.22.6.43.638",
    "detail_list": "",
    "options": "IdentityVerify;DisableDQChecks;messageVerbose",
    "messages": [
      {
        "code": "XXXX",
        "value": "0;0;0;3;3;0;0;0;0;3;0;3;3;0;0;0;0;4;3;0;0;0;0;3;3"
      },
      {
        "code": "Codes",
        "value": "XXX-XXX-XXXXXXXXXX;XXX-XXX-XXXXXXXXXX;XXX-XXX-XXXXXXXXXX"
      },
      {
        "code": "MatchCodes",
        "value": "XXXX-XX:XXXX-XX:XXXX-XXX:XXXX-XX"
      },
      {
        "code": "1MT-AU-MATCHED-1+1",
        "value": "Full Match for 1+1 verification"
      }
    ],
    "detailList": ""
  },
  "contactType": "",
  "nameQualified": "",
  "organizationName": "",
  "qualificationIntFirst": "",
  "qualificationIntSecond": "",
  "qualificationSuceeding": "",
  "surnameFirst": "Nery",
  "surnamePrefixFirst": "",
  "surnamePrefixSecond": "",
  "Status": "Full Match",
  "rapidID": "check-id"
}

Status: 200 OK

{
  "completename": "Adalgisa Nery",
  "formofaddress": "",
  "qualificationpreceding": "",
  "givenfullname": "Adalgisa",
  "givennameinitials": "",
  "qualification_int_first": "",
  "surname_prefix_first": "",
  "surname_first": "Nery",
  "indicator": "",
  "qualification_int_second": "",
  "surname_prefix_second": "",
  "qualification_suceeding": "",
  "name_qualified": "",
  "function": "",
  "gender": "",
  "nationality": "",
  "nationalid": "11111111",
  "organization_name": "",
  "dob": "08/08/1987",
  "businessid": "",
  "contact_type": "",
  "countryCode": "US",
  "passport": "",
  "codes": {
    "reliability": "20",
    "adaptation": "0",
    "detailCode": "WS-333865.2020.0.1.22.6.43.638",
    "detail_list": "",
    "options": "IdentityVerify;DisableDQChecks;messageVerbose",
    "messages": [
      {
        "code": "XXXX",
        "value": "0;0;0;3;3;0;0;0;0;3;0;3;3;0;0;0;0;4;3;0;0;0;0;3;3"
      },
      {
        "code": "Codes",
        "value": "XXX-XXX-XXXXXXXXXX;XXX-XXX-XXXXXXXXXX;XXX-XXX-XXXXXXXXXX"
      },
      {
        "code": "MatchCodes",
        "value": "XXXX-XX:XXXX-XX:XXXX-XXX:XXXX-XX"
      }
    ],
    "detailList": ""
  },
  "contactType": "",
  "nameQualified": "",
  "organizationName": "",
  "qualificationIntFirst": "",
  "qualificationIntSecond": "",
  "qualificationSuceeding": "",
  "surnameFirst": "Nery",
  "surnamePrefixFirst": "",
  "surnamePrefixSecond": "",
  "Status": "Partial Match",
  "rapidID": "check-id"
}

Status: 200 OK

{
  "completename": "Adalgisa Nery",
  "formofaddress": "",
  "qualificationpreceding": "",
  "givenfullname": "Adalgisa",
  "givennameinitials": "",
  "qualification_int_first": "",
  "surname_prefix_first": "",
  "surname_first": "Nery",
  "indicator": "",
  "qualification_int_second": "",
  "surname_prefix_second": "",
  "qualification_suceeding": "",
  "name_qualified": "",
  "function": "",
  "gender": "",
  "nationality": "",
  "nationalid": "22222222",
  "organization_name": "",
  "dob": "08/08/1987",
  "businessid": "",
  "contact_type": "",
  "countryCode": "US",
  "passport": "",
  "codes": {
    "reliability": "30",
    "adaptation": "0",
    "detailCode": "WS-333865.2020.0.1.22.6.43.638",
    "detail_list": "",
    "options": "IdentityVerify;DisableDQChecks;messageVerbose",
    "messages": [
      {
        "code": "Codes",
        "value": ""
      }
    ],
    "detailList": ""
  },
  "contactType": "",
  "nameQualified": "",
  "organizationName": "",
  "qualificationIntFirst": "",
  "qualificationIntSecond": "",
  "qualificationSuceeding": "",
  "surnameFirst": "Nery",
  "surnamePrefixFirst": "",
  "surnamePrefixSecond": "",
  "Status": "No Match",
  "rapidID": "check-id"
}

Status: 200 OK

{
  "Status": "Request Error",
  "rapidID": "check-id"
}

Status: 200 OK

{
  "completename": "Adalgisa Nery",
  "formofaddress": "",
  "qualificationpreceding": "",
  "givenfullname": "Adalgisa",
  "givennameinitials": "",
  "qualification_int_first": "",
  "surname_prefix_first": "",
  "surname_first": "Nery",
  "indicator": "",
  "qualification_int_second": "",
  "surname_prefix_second": "",
  "qualification_suceeding": "",
  "name_qualified": "",
  "function": "",
  "gender": "",
  "nationality": "",
  "nationalid": "22222222",
  "organization_name": "",
  "dob": "08/08/1987",
  "businessid": "",
  "contact_type": "",
  "countryCode": "CA",
  "passport": "",
  "codes": {
    "reliability": "30",
    "adaptation": "30",
    "detailCode": "WS-8962990.2022.2.8.5.59.38.97",
    "detail_list": "",
    "options": "IdentityVerify;DisableDQChecks;messageVerbose",
    "messages": [
      {
        "code": "ACCOUNT_NUMBER",
        "value": "RD16165"
      },
      {
        "code": "CONSENT",
        "value": "YES"
      },
      {
        "code": "PST1",
        "value": "0;0;0;3;3;0;3;0;3;3;0;3;3;0;0;0;0;0;3;0;4;4;4;3;3"
      },
      {
        "code": "Codes",
        "value": "ACCOUNT_NUMBER;CONSENT;PST1;"
      },
      {
        "code": "MatchCodes",
        "value": ""
      }
    ],
    "detailList": ""
  },
  "contactType": "",
  "nameQualified": "",
  "organizationName": "",
  "qualificationIntFirst": "",
  "qualificationIntSecond": "",
  "qualificationSuceeding": "",
  "surnameFirst": "Nery",
  "surnamePrefixFirst": "",
  "surnamePrefixSecond": "",
  "Status": "No Match",
  "rapidID": "check-id"
}

Status: 200 OK

{
  "error": "Please provide first and last name"
}