Global ID Verification (eidv/2+2)

Request

Method: POST

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

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

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": "XXX-XX-MATCHED-2+2",
        "value": "Full Match for 2+2 verification"
      }
    ],
    "detailList": ""
  },
  "contactType": "",
  "nameQualified": "",
  "organizationName": "",
  "qualificationIntFirst": "",
  "qualificationIntSecond": "",
  "qualificationSuceeding": "",
  "surnameFirst": "Nery",
  "surnamePrefixFirst": "",
  "surnamePrefixSecond": "",
  "Status": "Full Match",
  "rapidID": "check-id"
}

Status: 400 Bad Request

{
  "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"
}